Skip to content

Commit c04a901

Browse files
committed
docs(crate): Pre-release updating
- Update both readme's - Update changelog - Bump version to 0.6.0
1 parent ca7bff4 commit c04a901

File tree

3 files changed

+77
-13
lines changed

3 files changed

+77
-13
lines changed

CHANGELOG.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,20 @@
22

33
## [Unreleased]
44

5+
6+
[unreleased]: https://github.com/FluenTech/embedded-time/compare/v0.6.0...HEAD
7+
8+
## [0.6.0] - 2020-07-03
9+
510
### Added
611

712
- A `Timer` type supporting one-shot and periodic software timers utilizing a `Clock` implementation
8-
- `Timer` unit tests
9-
- Fallibility to `Clock` methods
13+
- Fallibility and error handling for `Clock` methods
1014
- `Instant::duration_until()` with order checking
1115
- Order checking to `Instant::duration_since()`
1216
- Bounds checking on `Instant` impls of Add/Sub
1317
- Changelog back to v0.5.0 release
18+
- [`crossbeam-utils`](https://crates.io/crates/crossbeam-utils) dev-dependency for scoped threads in tests
1419

1520
### Changed
1621

@@ -19,7 +24,7 @@
1924
- `Instant::duration_since()` return type to `Result`
2025
- Refactor `examples/nrf52_dk`
2126

22-
[unreleased]: https://github.com/FluenTech/embedded-time/compare/v0.5.2...HEAD
27+
[0.6.0]: https://github.com/FluenTech/embedded-time/compare/v0.5.2...v0.6.0
2328

2429
## [0.5.2] - 2020-06-21
2530

README.md

Lines changed: 35 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,42 @@
55
[docs.rs]: https://docs.rs/embedded-time/badge.svg
66

77
`embedded-time` provides a comprehensive library for implementing abstractions over
8-
hardware and work with _clocks_, _instants_, _durations_, _periods_, and _frequencies_ in a more intuitive way.
9-
8+
hardware and work with _clocks_, _timers_, _instants_, _durations_, _periods_, and _frequencies_ in a more intuitive way.
9+
10+
## Hardware Abstraction
11+
1012
- `Clock` trait allowing abstraction of hardware timers for timekeeping.
11-
- Work with time using _milliseconds_, _seconds_, _hertz_, etc. rather than _cycles_ or _ticks_.
12-
- Includes example for the nRF52_DK board
13-
- Conversion to/from core::time::Duration
13+
14+
## Timers
15+
16+
- Software timers spawned from a `Clock` impl object.
17+
- One-shot or periodic/continuous
18+
- Blocking delay
19+
- Poll for expiration
20+
- Read elapsed/remaining duration
21+
22+
## Duration Types
23+
24+
- Nanoseconds
25+
- Microseconds
26+
- Milliseconds
27+
- Seconds
28+
- Minutes
29+
- Hours
30+
31+
## Frequency Type
32+
33+
- Hertz
34+
35+
## `core` Compatibility
36+
37+
- Conversion to/from `core::time::Duration`
38+
39+
## Reliability and Usability
40+
- Extensive tests
41+
- Thorough documentation with examples
42+
- Example for the nRF52_DK board
43+
1444

1545
## License
1646
This project is licensed under either of

crates-io.md

Lines changed: 34 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,41 @@
11
# embedded-time
22

33
`embedded-time` provides a comprehensive library for implementing abstractions over
4-
hardware and work with _clocks_, _instants_, _durations_, _periods_, and _frequencies_ in a more intuitive way.
5-
4+
hardware and work with _clocks_, _timers_, _instants_, _durations_, _periods_, and _frequencies_ in a more intuitive way.
5+
6+
## Hardware Abstraction
7+
68
- `Clock` trait allowing abstraction of hardware timers for timekeeping.
7-
- Work with time using _milliseconds_, _seconds_, _hertz_, etc. rather than _cycles_ or _ticks_.
8-
- Includes example for the nRF52_DK board
9-
- Conversion to/from core::time::Duration
9+
10+
## Timers
11+
12+
- Software timers spawned from a `Clock` impl object.
13+
- One-shot or periodic/continuous
14+
- Blocking delay
15+
- Poll for expiration
16+
- Read elapsed/remaining duration
17+
18+
## Duration Types
19+
20+
- Nanoseconds
21+
- Microseconds
22+
- Milliseconds
23+
- Seconds
24+
- Minutes
25+
- Hours
26+
27+
## Frequency Type
28+
29+
- Hertz
30+
31+
## `core` Compatibility
32+
33+
- Conversion to/from `core::time::Duration`
34+
35+
## Reliability and Usability
36+
- Extensive tests
37+
- Thorough documentation with examples
38+
- Example for the nRF52_DK board
1039

1140
## Motivation
1241
The handling of time on embedded systems is generally much different than that of OSs. For instance, on an OS, the time is measured against an arbitrary epoch. Embedded systems generally don't know (nor do they care) what the *real* time is, but rather how much time has passed since the system has started.

0 commit comments

Comments
 (0)