Prepare 0.5.1 (#160)

Author: gferon

CHANGELOG.md

@@ -9,8 +9,28 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
+### Fixed
+
+### Changed
+
+## [0.5.1]
+
+Note: this release splits the project into multiple crates, to prepare for adding concurrent store implementations.
+While this might seem like a breaking change, the API has not been altered and your `Cargo.toml` should now look like:
+
+```toml
+[dependencies]
+presage = { git = "https://github.com/whisperfish/presage" }
+presage-store-sled = { git = "https://github.com/whisperfish/presage" }
+```
+
+and then get the store implementation from the store crate instead when importing it like `use presage_store_sled::SledStore;`.
+
+### Added
+
 - Add `Manager::submit_recaptcha_challenge`. (#143)
 - Cache profile API responses. (#134)
+- Add `is_registered` method to the store trait. (#156)
 
 ### Fixed
 
@@ -23,7 +43,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Handle message deletion sent by contacts. (#147)
 - Split `presage` into multiple crates, before introducing additional store implementations. (#148)
-- Messages are now sent, whenever possible (which should be all the time), as [sealed sender](https://signal.org/blog/sealed-sender/). [#159] 
+- Messages are now sent, whenever possible (which should be all the time), as [sealed sender](https://signal.org/blog/sealed-sender/). [#159]
+- Split project into multiple crates. (#148)
 
 ## [0.5.0]
 
@@ -52,3 +73,5 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Encrypt registration data (when store encryption is enabled). (#114)
 
 [0.5.0]: https://github.com/whisperfish/presage/compare/0.4.0...0.5.0
+[0.5.1]: https://github.com/whisperfish/presage/compare/0.5.0...0.5.1
+[Unreleased]: https://github.com/whisperfish/presage/compare/0.5.1...main

README.md

@@ -27,33 +27,29 @@ Features:
 
 ## Instructions
 
-Included in this repository is a CLI very similar (on purpose) to the great [signal-cli](https://github.com/AsamK/signal-cli):
+Add the following to your `Cargo.toml`:
 
+```toml
+[dependencies]
+presage = { git = "https://github.com/whisperfish/presage" }
+presage-store-sled = { git = "https://github.com/whisperfish/presage" }
 ```
-# print help section
-cargo run --example=cli -- --help
-
-# link as secondary device, a PNG with a QR code to scan should open
-cargo run --example=cli -- link-device --device-name presage
 
-# start receiving messages
-cargo run --example=cli -- receive
-```
+and look at the generated Rust documentation of the `Manager` struct to get started.
 
-For usage of the library, a few examples are included under the `examples/` directory, and most features are demonstrated
-in [examples/cli.rs](./examples/cli.rs).
+## Demo CLI
 
-## Migration notes
+Included in this repository is a CLI very similar (on purpose) to the great [signal-cli](https://github.com/AsamK/signal-cli):
 
-### Migrating from `0.5.x` to `0.6.x`
+```
+# print help section
+cargo run -- --help
 
-Apart from the few obvious changes in the API, one of the main differences between both versions is that you will now
-require to use two crates as `[dependencies]`, one for the library and one for the store backend, which could look like:
+# link as secondary device, a PNG with a QR code to scan should open
+cargo run -- link-device --device-name presage
 
-```toml
-[dependencies]
-presage = { git = "https://github.com/whisperfish/presage" }
-presage-store-sled = { git = "https://github.com/whisperfish/presage" }
+# start receiving messages
+cargo run -- receive
 ```
 
-and then get the store implementation from the store crate instead when importing it like `use presage_store_sled::SledStore;`.
+For using the library, the CLI is a good starting point to learn how the API can be used.