Skip to content

Commit

Permalink
chore: update README to include MSRV and features
Browse files Browse the repository at this point in the history
Signed-off-by: Lachezar Lechev <[email protected]>
  • Loading branch information
elpiel committed Jan 22, 2024
1 parent e77fa2d commit d3fd059
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 1 deletion.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Include [library](https://crates.io/crates/bmp388) as a dependency in your Cargo
version = "<version>"
```

Use embedded-hal implementation to get I2C handle and delay then create bmp388 handle:
Use [`embedded-hal`](https://crates.io/crates/embedded-hal) implementation to get I2C handle and delay then create bmp388 handle:

```rust
extern crate bmp388; // or just use bmp388; if 2018 edition is used.
Expand All @@ -24,10 +24,22 @@ let pres = ps.sensor_values();
println!("{:?}", pres);
```


## Documentation

API Docs available on [docs.rs](https://docs.rs/bmp388).

## Features

- default: none enabled by default
- `defmt-03` - enable [`[email protected]`](crates.io/crates/defmt) formatting for structs and enums
- `serde` - enable [`serde`](crates.io/crates/serde) Deserialize and Serialize implementations on structs and enums
- `asynch` - enable [`embedded-hal-async`](https://crates.io/crates/embedded-hal-async) implementation for the Asynchronous API.
- `config-builder` - enable the typed config builder `ConfigBuilder` for setting up the sensor and initializing it.

## Minimum supported Rust version (MSRV)
For the blocking API the MSRV is `1.65`, however, for the asynchronies API, enabled with the feature `asynch`, the MSRV is `1.75`.

## ToDo:

* Implement FiFo Buffer support
Expand Down
1 change: 1 addition & 0 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ use embedded_hal as ehal;
use num_traits::Pow;

#[cfg(feature = "config-builder")]
#[doc(inline)]
pub use config::{Config, ConfigBuilder};
use config::{InterruptConfig, OversamplingConfig, Register};

Expand Down

0 comments on commit d3fd059

Please sign in to comment.