Skip to content

Commit 5656688

Browse files
committed
Update README & Cargo.toml description
1 parent 21985fe commit 5656688

File tree

2 files changed

+19
-7
lines changed

2 files changed

+19
-7
lines changed

Cargo.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
name = "embedded-fps"
33
version = "0.1.0"
44
authors = ["Lechev.space <[email protected]>", "Lachezar Lechev"]
5-
description = ""
5+
description = "Frames per second counter for embedded devices"
66
categories = ["embedded", "no-std", "graphics"]
77

88
keywords = ["graphics", "embedded", "no_std", "frames per second", "fps"]

README.md

+18-6
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
1-
# embedded-fps
1+
# `embedded-fps`
22
[![sponsor-us]](https://github.com/sponsors/LechevSpace)&ensp;[![crates-io]](https://crates.io/crates/embedded-fps)&ensp;[![docs-rs]](https://docs.rs/embedded-fps)
3-
## Frames Per Second counter for embedded devices.
3+
4+
## Frames Per Second counter for embedded devices
45

56
Create an `FPS` struct by passing the `MAX_FPS` (maximum frames per seconds)
6-
that you expect to hit and a [`embedded_time`][embedded-time-docs]`::Clock` implementation.
7+
that you expect to hit and a [`embedded_time`][embedded-time-docs] `Clock` implementation.
78

89
[embedded-time-docs]: https://docs.rs/embedded-time/
910
[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:
3435

3536
## Crate features
3637

37-
- `std` - enables [`StdClock`] - a [`Clock`] implementation using [`std`] for usage on a host machine.
38+
- `std` - enables `StdClock` - a `Clock` implementation using `std` for usage on a host machine.
39+
40+
## License
41+
42+
Licensed under either of [Apache License, Version 2.0](./LICENSE-APACHE)
43+
or [MIT license](./LICENSE-MIT) at your option.
44+
45+
### Contribution
46+
47+
Unless you explicitly state otherwise, any contribution intentionally submitted
48+
for inclusion in this project by you, as defined in the Apache-2.0 license,
49+
shall be dual licensed as above, without any additional terms or conditions.
3850

39-
[`StdClock`]: crate::StdClock
4051
[`embedded-graphics`]: https://crates.io/crates/embedded-graphics
4152
[`embedded-graphics-simulator`]: https://crates.io/crates/embedded-graphics-simulator
42-
[simulator-docs]: https://docs.rs/embedded-graphics-simulator/latest/embedded_graphics_simulator/#setup
53+
[simulator-docs]: https://docs.rs/embedded-graphics-simulator/latest/embedded_graphics_simulator/#setup
54+
[`StdClock`]: crate::StdClock

0 commit comments

Comments
 (0)