diff --git a/CHANGELOG.md b/CHANGELOG.md index 6d91fda..82567f6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -26,10 +26,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - EffortlessConfig now takes keyword parameters instead of a dictioniary - Use from_dict if you need the old functionality -### Docs - -- TODO - ## [1.2.0.1] - 2024-10-22 ### Added diff --git a/docs/docs/advanced-usage.html b/docs/docs/advanced-usage.html index 6e31250..0609712 100644 --- a/docs/docs/advanced-usage.html +++ b/docs/docs/advanced-usage.html @@ -41,8 +41,7 @@
You can futher customize the database with a configuration:
Require fields for each entry in the DB.
Make the database automatically back up to the specified path.
- The internal version of the database. + The internal version of the database. This is used for + automatic migration between versions of Effortless.
- Creates an EffortlessConfig with the given configuration - options. EffortlessConfig creation will be changed in - 1.3.0. + Creates an EffortlessConfig with any specified + configuration options.
+ +Converts the configuration to a dictionary - representation. You can use this to edit a config before - re-applying it. + representation. You can use this to save a config or + edit a config as a dict before re-applying it.
+ Converts a dictionary into an EffortlessConfig object. +
+ ++ Checks if the given database follows the configured + rules. Raises ValueError if anything doesn't follow. + This must pass for a new configuration to be applied to + a database. +
++ The encryption key (password) used to encrypt and + decrypt the database. +
++ Sets a new encryption key and re-encrypts the database + if necessary. If the database is already encrypted, this + method will attempt to decrypt with both the old and new + keys, then re-encrypt with the new key. +
++ Permanently unencrypts the database using the encryption + key if the database is currently encrypted. Raises a + ValueError if an encryption key is not set. +
+