Version 0.902

[chaz/p5-File-KDBX] / README

diff --git a/README b/README
index 06be87c3ad1d7f20b7f645e13de64a2c92eadc68..ec6508e533074da94cef2083aa26c75a1028c4e5 100644 (file)
--- a/README
+++ b/README
@@ -4,28 +4,33 @@ NAME
 
 VERSION
 
-    version 0.901
+    version 0.902
 
 SYNOPSIS
 
         use File::KDBX;
     
+        # Create a new database from scratch
         my $kdbx = File::KDBX->new;
     
+        # Add some objects to the database
         my $group = $kdbx->add_group(
             name => 'Passwords',
         );
-    
         my $entry = $group->add_entry(
             title    => 'My Bank',
+            username => 'mreynolds',
             password => 's3cr3t',
         );
     
+        # Save the database to the filesystem
         $kdbx->dump_file('passwords.kdbx', 'M@st3rP@ssw0rd!');
     
-        $kdbx = File::KDBX->load_file('passwords.kdbx', 'M@st3rP@ssw0rd!');
+        # Load the database from the filesystem into a new database instance
+        my $kdbx2 = File::KDBX->load_file('passwords.kdbx', 'M@st3rP@ssw0rd!');
     
-        $kdbx->entries->each(sub {
+        # Iterate over database entries, print entry titles
+        $kdbx2->entries->each(sub {
             my ($entry) = @_;
             say 'Entry: ', $entry->title;
         });
@@ -148,7 +153,7 @@ ATTRIBUTES
     The UUID of a cipher used to encrypt the database when stored as a
     file.
 
-    See "File::KDBX::Cipher".
+    See File::KDBX::Cipher.
 
  compression_flags
 
@@ -464,8 +469,8 @@ METHODS
     was introduced with KDBX4.
 
     This method never returns less than KDBX_VERSION_3_1 (i.e. 0x00030001).
-    That file version is so ubiquitious and well-supported, there are
-    seldom reasons to dump in a lesser format nowadays.
+    That file version is so ubiquitous and well-supported, there are seldom
+    reasons to dump in a lesser format nowadays.
 
     WARNING: If you dump a database with a minimum version higher than the
     current "version", the dumper will typically issue a warning and
@@ -1456,7 +1461,7 @@ QUERY
     Iterators are the built-in way to navigate or walk the database tree.
     You get an iterator from "entries", "groups" and "objects". You can
     specify the search algorithm to iterate over objects in different
-    orders using the algorith option, which can be one of these constants:
+    orders using the algorithm option, which can be one of these constants:
 
       * ITERATION_IDS - Iterative deepening search (default)
 
@@ -1582,15 +1587,6 @@ ENVIRONMENT
 
       * NO_FORK - Do not fork if true (default: false)
 
-CAVEATS
-
-    Some features (e.g. parsing) require 64-bit perl. It should be possible
-    and actually pretty easy to make it work using Math::BigInt, but I need
-    to build a 32-bit perl in order to test it and frankly I'm still
-    figuring out how. I'm sure it's simple so I'll mark this one "TODO",
-    but for now an exception will be thrown when trying to use such
-    features with undersized IVs.
-
 SEE ALSO
 
       * KeePass Password Safe <https://keepass.info/> - The original