diff --git a/README.md b/README.md index c6407cf..034cf89 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,24 @@ # Psst Documentation -Pretty Secure Secret Transactions +### Pretty Secure Secret Transactions This plugin is gives visitors a way to create one time secrets that expire after viewing. -By default all secrets are secured using WordPress salts and SHA256 encryption. Once a item is viewed the secret is -deleted from the database. Once the secret expires it is deleted from the database. +## How Does it work? -**This plugin works most effectively when using a true cron and not specifically relying on WordPress built in scheduler** +This project is a WordPress plugin, While it can be used in conjunction with your site, it may make sense to create a stand alone site as it has a specific purpose. + +By default all secrets are secured using WordPress [defuse/php-encryption](https://github.com/defuse/php-encryption). +* Once a secret is viewed, the secret is deleted from the database. +* Once the secret expires it is deleted from the database. + +## Dependencies + +[defuse/php-encryption](https://github.com/defuse/php-encryption) This is used for encryting post data. + +## Good to Haves + +**This plugin works most effectively when using a true crontab and not specifically relying on WordPress built in scheduler** This will allow for better accuracy when doing general cleanup. ## Crons @@ -17,5 +28,7 @@ By default 3 cron events are scheduled * Daily: Daily audit to purge any potentially missed secrets ## Changelog +### Version: 1.0.1 + * Fixed an issue with pass phase protected posts not being displayed. -Version: 1.0.0 Initial Release: +### Version: 1.0.0 Initial Release: