Release File-KDBX 0.906

[chaz/p5-File-KDBX] / README.md

diff --git a/README.md b/README.md
index defdf98efed0c02a179902d76aff8abc5ffb11e9..6261811b277a17d475f322e61ad6e7a6ced0d498 100644 (file)
--- a/README.md
+++ b/README.md
@@ -8,7 +8,7 @@ File::KDBX - Encrypted database to store secret text and files
 
 # VERSION
 
-version 0.902
+version 0.906
 
 # SYNOPSIS
 
@@ -29,14 +29,13 @@ my $entry = $group->add_entry(
 );
 
 # Save the database to the filesystem
-$kdbx->dump_file('passwords.kdbx', 'M@st3rP@ssw0rd!');
+$kdbx->dump_file('passwords.kdbx', 'masterpw changeme');
 
 # Load the database from the filesystem into a new database instance
-my $kdbx2 = File::KDBX->load_file('passwords.kdbx', 'M@st3rP@ssw0rd!');
+my $kdbx2 = File::KDBX->load_file('passwords.kdbx', 'masterpw changeme');
 
 # Iterate over database entries, print entry titles
-$kdbx2->entries->each(sub {
-    my ($entry) = @_;
+$kdbx2->entries->each(sub($entry, @) {
     say 'Entry: ', $entry->title;
 });
 ```
@@ -123,7 +122,7 @@ Bytes contained within the encrypted layer of a KDBX file. This is only set when
 
 ## comment
 
-A text string associated with the database. Often unset.
+A text string associated with the database stored unencrypted in the file header. Often unset.
 
 ## cipher\_id
 
@@ -154,7 +153,7 @@ The transform seed _should_ be changed each time the database is saved to file.
 ## transform\_rounds
 
 The number of rounds or iterations used in the key derivation function. Increasing this number makes loading
-and saving the database slower by design in order to make dictionary and brute force attacks more costly.
+and saving the database slower in order to make dictionary and brute force attacks more costly.
 
 ## encryption\_iv
 
@@ -547,7 +546,7 @@ $kdbx->add_entry($entry, %options);
 $kdbx->add_entry(%entry_attributes, %options);
 ```
 
-Add a entry to a database. This is equivalent to identifying a parent group and calling
+Add an entry to a database. This is equivalent to identifying a parent group and calling
 ["add\_entry" in File::KDBX::Group](https://metacpan.org/pod/File%3A%3AKDBX%3A%3AGroup#add_entry) on the parent group, forwarding the arguments. Available options:
 
 - `group` - Group object or group UUID to add the entry to (default: root group)
@@ -843,7 +842,7 @@ Remove just as many older historical entries as necessary to get under certain l
 
 - `max_items` - Maximum number of historical entries to keep (default: value of ["history\_max\_items"](#history_max_items), no limit: -1)
 - `max_size` - Maximum total size (in bytes) of historical entries to keep (default: value of ["history\_max\_size"](#history_max_size), no limit: -1)
-- `max_age` - Maximum age (in days) of historical entries to keep (default: 365, no limit: -1)
+- `max_age` - Maximum age (in days) of historical entries to keep (default: value of ["maintenance\_history\_days"](#maintenance_history_days), no limit: -1)
 
 ## randomize\_seeds
 
@@ -861,7 +860,7 @@ secure the database when dumped. The attributes that will be randomized are:
 - ["transform\_seed"](#transform_seed)
 
 Randomizing these values has no effect on a loaded database. These are only used when a database is dumped.
-You normally do not need to call this method explicitly because the dumper does it explicitly by default.
+You normally do not need to call this method explicitly because the dumper does it for you by default.
 
 ## key
 
@@ -964,8 +963,7 @@ $kdbx->dump_file('mypasswords.kdbx', 'master password CHANGEME');
 my $kdbx = File::KDBX->load_file('mypasswords.kdbx', 'master password CHANGEME');
 $kdbx->unlock;  # cause $entry->password below to be defined
 
-$kdbx->entries->each(sub {
-    my ($entry) = @_;
+$kdbx->entries->each(sub($entry, @) {
     say 'Found password for: ', $entry->title;
     say '  Username: ', $entry->username;
     say '  Password: ', $entry->password;
@@ -1042,7 +1040,7 @@ The first factor is up to you. This module does not enforce strong master keys.
 generate strong keys.
 
 The KDBX format allows for the key derivation function to be tuned. The idea is that you want each single
-brute-foce attempt to be expensive (in terms of time, CPU usage or memory usage), so that making a lot of
+brute-force attempt to be expensive (in terms of time, CPU usage or memory usage), so that making a lot of
 attempts (which would be required if you have a strong master key) gets _really_ expensive.
 
 How expensive you want to make each attempt is up to you and can depend on the application.
@@ -1188,7 +1186,7 @@ my $entries = $kdbx->entries->where(\5, '>=', qw[usage_count]);
 
 It helps to read it right-to-left, like "usage\_count is greater than or equal to 5".
 
-If you find the disambiguating structures to be distracting or confusing, you can also the
+If you find the disambiguating structures to be distracting or confusing, you can also use the
 ["simple\_expression\_query" in File::KDBX::Util](https://metacpan.org/pod/File%3A%3AKDBX%3A%3AUtil#simple_expression_query) function as a more intuitive alternative. The following example is
 equivalent to the previous:
 
@@ -1247,7 +1245,7 @@ my $entries = $kdbx->entries->where({
 Note: ["ICON\_SMARTPHONE" in File::KDBX::Constants](https://metacpan.org/pod/File%3A%3AKDBX%3A%3AConstants#ICON_SMARTPHONE) is just a constant from [File::KDBX::Constants](https://metacpan.org/pod/File%3A%3AKDBX%3A%3AConstants). It isn't
 special to this example or to queries generally. We could have just used a literal number.
 
-The important thing to notice here is how we wrapped the condition in another arrayref with a single key-value
+The important thing to notice here is how we wrapped the condition in another hashref with a single key-value
 pair where the key is the name of an operator and the value is the thing to match against. The supported
 operators are: