Update README & Cargo.toml description

LechevSpace · Jun 13, 2022 · 5656688 · 5656688
1 parent 21985fe
commit 5656688
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 7 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -2,7 +2,7 @@
 name = "embedded-fps"
 version = "0.1.0"
 authors = ["Lechev.space <dev@lechev.space>", "Lachezar Lechev"]
-description = ""
+description = "Frames per second counter for embedded devices"
 categories = ["embedded", "no-std", "graphics"]
 
 keywords = ["graphics", "embedded", "no_std", "frames per second", "fps"]

diff --git a/README.md b/README.md
@@ -1,9 +1,10 @@
-# embedded-fps
+# `embedded-fps`
 [![sponsor-us]](https://github.com/sponsors/LechevSpace)&ensp;[![crates-io]](https://crates.io/crates/embedded-fps)&ensp;[![docs-rs]](https://docs.rs/embedded-fps)
-## Frames Per Second counter for embedded devices.
+
+## Frames Per Second counter for embedded devices
 
 Create an `FPS` struct by passing the `MAX_FPS` (maximum frames per seconds)
-that you expect to hit and a [`embedded_time`][embedded-time-docs]`::Clock` implementation.
+that you expect to hit and a [`embedded_time`][embedded-time-docs] `Clock` implementation.
 
 [embedded-time-docs]: https://docs.rs/embedded-time/
 [crates-io]: https://img.shields.io/crates/v/embedded-fps?logo=rust&style=for-the-badge
@@ -34,9 +35,20 @@ You can run this example from the `examples` directory using:
 
 ## Crate features
 
-- `std` - enables [`StdClock`] - a [`Clock`] implementation using [`std`] for usage on a host machine.
+- `std` - enables `StdClock` - a `Clock` implementation using `std` for usage on a host machine.
+
+## License
+
+Licensed under either of [Apache License, Version 2.0](./LICENSE-APACHE)
+or [MIT license](./LICENSE-MIT) at your option.
+
+### Contribution
+
+Unless you explicitly state otherwise, any contribution intentionally submitted
+for inclusion in this project by you, as defined in the Apache-2.0 license,
+shall be dual licensed as above, without any additional terms or conditions.
 
-[`StdClock`]: crate::StdClock
 [`embedded-graphics`]: https://crates.io/crates/embedded-graphics
 [`embedded-graphics-simulator`]: https://crates.io/crates/embedded-graphics-simulator
-[simulator-docs]: https://docs.rs/embedded-graphics-simulator/latest/embedded_graphics_simulator/#setup
+[simulator-docs]: https://docs.rs/embedded-graphics-simulator/latest/embedded_graphics_simulator/#setup
+[`StdClock`]: crate::StdClock