Skip to content

Commit 47d012f

Browse files
committed
docs: update readmes for v1.0
1 parent df0fd0a commit 47d012f

File tree

3 files changed

+4
-42
lines changed

3 files changed

+4
-42
lines changed

README.md

Lines changed: 3 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44
55
This project is developed and maintained by the [HAL team](https://github.com/rust-embedded/wg#the-hal-team).
66

7+
📣 `embedded-hal` v1.0 is now released! Check out the [announcement blog post](https://blog.rust-embedded.org/embedded-hal-v1/), the [API documentation](https://docs.rs/embedded-hal) and the [migration guide](docs/migrating-from-0.2-to-1.0.md).
8+
79
## Scope
810

911
`embedded-hal` serves as a foundation for building an ecosystem of platform-agnostic drivers.
@@ -38,24 +40,10 @@ The main `embedded-hal` project is not tied to a specific execution model like
3840
| [embedded-io-async](./embedded-io-async) | [![crates.io](https://img.shields.io/crates/v/embedded-io-async.svg)](https://crates.io/crates/embedded-io-async) | [![Documentation](https://docs.rs/embedded-io-async/badge.svg)](https://docs.rs/embedded-io-async) | I/O traits, async version |
3941
| [embedded-io-adapters](./embedded-io-adapters) | [![crates.io](https://img.shields.io/crates/v/embedded-io-adapters.svg)](https://crates.io/crates/embedded-io-adapters) | [![Documentation](https://docs.rs/embedded-io-adapters/badge.svg)](https://docs.rs/embedded-io-adapters) | Adapters between the [`embedded-io`](https://crates.io/crates/embedded-io) and [`embedded-io-async`](https://crates.io/crates/embedded-io-async) traits and other IO traits (`std`, `tokio`, `futures`...) |
4042

41-
## Releases
42-
43-
At the moment we are working towards a `1.0.0` release (see [#177]). During this process we will
44-
release alpha versions like `1.0.0-alpha.1` and `1.0.0-alpha.2`.
45-
Alpha releases are **not guaranteed** to be compatible with each other.
46-
They are provided as early previews for community testing and preparation for the final release.
47-
If you use an alpha release, we recommend you choose an exact version specification in your
48-
`Cargo.toml` like: `embedded-hal = "=1.0.0-alpha.9"`
49-
50-
See [this guide](docs/version-policy.md) for a way to implement both an `embedded-hal` `0.2.x`
51-
version and an `-alpha` version side by side in a HAL.
52-
53-
[#177]: https://github.com/rust-embedded/embedded-hal/issues/177
54-
5543
## Documents
5644

45+
- [Migrating from v0.2 to v1.0](docs/migrating-from-0.2-to-1.0.md).
5746
- [How-to: add a new trait](docs/how-to-add-a-new-trait.md)
58-
- [Version policy](docs/version-policy.md)
5947
- [MSRV](docs/msrv.md)
6048

6149
## Implementations and drivers

docs/version-policy.md

Lines changed: 0 additions & 26 deletions
This file was deleted.

embedded-hal-bus/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ This project is developed and maintained by the [HAL team](https://github.com/ru
1515

1616
To support bus sharing, `embedded-hal` provides the `SpiBus` and `SpiDevice` traits. `SpiBus` represents an entire bus,
1717
while `SpiDevice` represents a device on that bus. For further details on these traits, please consult the
18-
[`embedded-hal` documentation](https://docs.rs/embedded-hal/1.0.0-alpha.10/embedded_hal/spi/index.html).
18+
[`embedded-hal` documentation](https://docs.rs/embedded-hal/latest/embedded_hal/spi/index.html).
1919

2020
`embedded-hal` trait implementations for microcontrollers should implement the `SpiBus` trait.
2121
However, device drivers should use the `SpiDevice` traits, _not the `SpiBus` traits_ if at all possible

0 commit comments

Comments
 (0)