Merge pull request #10 from jucr-io/prep-release

Prepare for a public release

README.md

@@ -1,6 +1,6 @@
 # firmware-controller
 
-This crate provides a macro, [`macro@controller`] that makes it easy to write controller logic for firmware.
+This crate provides a macro named `controller` that makes it easy to write controller logic for firmware.
 
 The controller is responsible for control of all the peripherals based on commands it receives
 from other parts of the code. It also notifies peers about state changes and events via signals.
@@ -159,16 +159,16 @@ The `controller` macro assumes that you have the following dependencies in your
 * `futures` with `async-await` feature enabled.
 * `embassy-sync`
 
-## Known limitations
+## Known limitations & Caveats
 
 * Currently only works as a singleton: you can create multiple instances of the controller but
   if you run them simultaneously, they'll interfere with each others' operation. We hope to remove
   this limitation in the future. Having said that, most firmware applications will only need a
   single controller instance.
 * Method args/return type can't be reference types.
-* Methods must be async
+* Methods must be async.
 * The maximum number of subscribers state change and signal streams is 16. We plan to provide an
   attribute to make this configurable in the future.
 * The type of all published fields must implement `Clone` and `Debug`.
-* warning about need to continuosly poll change streams
-  * missed notification otherwise
+* The signal and published fields' streams must be continuely polled. Otherwise notifications will
+  be missed.