Skip to content

Commit 81d451b

Browse files
committed
Update README.md
1 parent f3470e3 commit 81d451b

File tree

3 files changed

+22
-27
lines changed

3 files changed

+22
-27
lines changed

README.j2

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232

3333
{{readme}}
3434

35-
@ 2020 Gero Gerke and [contributors].
35+
@ 2020-2024 Gero Gerke, msrd0 and [contributors].
3636

3737
[contributors]: https://github.com/influxdb-rs/influxdb-rust/graphs/contributors
3838
{%- if links != "" %}

README.md

+14-16
Original file line numberDiff line numberDiff line change
@@ -30,20 +30,18 @@
3030
</a>
3131
</p>
3232

33-
This library is a work in progress. This means a feature you might need is not implemented yet or could be handled better.
34-
3533
Pull requests are always welcome. See [Contributing][__link0] and [Code of Conduct][__link1]. For a list of past changes, see [CHANGELOG.md][__link2].
3634

3735

3836
### Currently Supported Features
3937

40-
- Reading and Writing to InfluxDB
41-
- Optional Serde Support for Deserialization
38+
- Reading and writing to InfluxDB
39+
- Optional Serde support for deserialization
4240
- Running multiple queries in one request (e.g. `SELECT * FROM weather_berlin; SELECT * FROM weather_london`)
4341
- Writing single or multiple measurements in one request (e.g. `WriteQuery` or `Vec<WriteQuery>` argument)
44-
- Authenticated and Unauthenticated Connections
42+
- Authenticated and unauthenticated connections
4543
- `async`/`await` support
46-
- `#[derive(InfluxDbWriteable)]` Derive Macro for Writing / Reading into Structs
44+
- `#[derive(InfluxDbWriteable)]` derive macro for writing / reading into structs
4745
- `GROUP BY` support
4846
- Tokio and async-std support (see example below) or [available backends][__link3]
4947
- Swappable HTTP backends ([see below](#Choice-of-HTTP-backend))
@@ -97,7 +95,7 @@ async fn main() -> Result<(), Error> {
9795

9896
client.query(weather_readings).await?;
9997

100-
// Let's see if the data we wrote is there
98+
// Read back all records
10199
let read_query = ReadQuery::new("SELECT * FROM weather");
102100

103101
let read_result = client.query(read_query).await?;
@@ -106,7 +104,7 @@ async fn main() -> Result<(), Error> {
106104
}
107105
```
108106

109-
For further examples, check out the Integration Tests in `tests/integration_tests.rs` in the repository.
107+
For further examples, check out the integration tests in `tests/integration_tests.rs` in the repository.
110108

111109

112110
## Choice of HTTP backend
@@ -121,37 +119,37 @@ To communicate with InfluxDB, you can choose the HTTP backend to be used configu
121119

122120
- **[hyper][__link7]** (through reqwest), with native TLS (OpenSSL)
123121
```toml
124-
influxdb = { version = "0.7.2", default-features = false,features = ["derive", "use-serde", "reqwest-client"] }
122+
influxdb = { version = "0.7.2", default-features = false, features = ["derive", "use-serde", "reqwest-client"] }
125123
```
126124

127125

128126
- **[hyper][__link8]** (through surf), use this if you need tokio 0.2 compatibility
129127
```toml
130-
influxdb = { version = "0.7.2", default-features = false,features = ["derive", "use-serde", "hyper-client"] }
128+
influxdb = { version = "0.7.2", default-features = false, features = ["derive", "use-serde", "hyper-client"] }
131129
```
132130

133131

134132
- **[curl][__link9]**, using [libcurl][__link10]
135133
```toml
136-
influxdb = { version = "0.7.2", default-features = false,features = ["derive", "use-serde", "curl-client"] }
134+
influxdb = { version = "0.7.2", default-features = false, features = ["derive", "use-serde", "curl-client"] }
137135
```
138136

139137

140138
- **[async-h1][__link11]** with native TLS (OpenSSL)
141139
```toml
142-
influxdb = { version = "0.7.2", default-features = false,features = ["derive", "use-serde", "h1-client"] }
140+
influxdb = { version = "0.7.2", default-features = false, features = ["derive", "use-serde", "h1-client"] }
143141
```
144142

145143

146144
- **[async-h1][__link12]** with [rustls][__link13]
147145
```toml
148-
influxdb = { version = "0.7.2", default-features = false,features = ["derive", "use-serde", "h1-client-rustls"] }
146+
influxdb = { version = "0.7.2", default-features = false, features = ["derive", "use-serde", "h1-client-rustls"] }
149147
```
150148

151149

152150
- WebAssembly’s `window.fetch`, via `web-sys` and **[wasm-bindgen][__link14]**
153151
```toml
154-
influxdb = { version = "0.7.2", default-features = false,features = ["derive", "use-serde", "wasm-client"] }
152+
influxdb = { version = "0.7.2", default-features = false, features = ["derive", "use-serde", "wasm-client"] }
155153
```
156154

157155

@@ -163,10 +161,10 @@ To communicate with InfluxDB, you can choose the HTTP backend to be used configu
163161

164162

165163

166-
@ 2020 Gero Gerke and [contributors].
164+
@ 2020-2024 Gero Gerke, msrd0 and [contributors].
167165

168166
[contributors]: https://github.com/influxdb-rs/influxdb-rust/graphs/contributors
169-
[__cargo_doc2readme_dependencies_info]: ggGkYW0BYXSEG_Yk-0hvrVPoG-pGw0Sym8kbG2s5Ga25QGRAG6zgaYax6AfsYXKEG5FQA0msUh34G1V6qHa_8CeQG66nRf4Jd7PiG99LD0P5Tiz5YWSBgmhpbmZsdXhkYmUwLjcuMg
167+
[__cargo_doc2readme_dependencies_info]: ggGkYW0BYXSEG_RDmlyxxvyrG0rwcLBKoYdvG5It9hbWNgjUGzjD8iBYfsFFYXKEG_jUEtkcTe33G_OOvfcbq3PhGx42EDLMgbCFGy0-H8MaqaBGYWSBgmhpbmZsdXhkYmUwLjcuMg
170168
[__link0]: https://github.com/influxdb-rs/influxdb-rust/blob/main/CONTRIBUTING.md
171169
[__link1]: https://github.com/influxdb-rs/influxdb-rust/blob/main/CODE_OF_CONDUCT.md
172170
[__link10]: https://curl.se/libcurl/

influxdb/src/lib.rs

+7-10
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,14 @@
1-
//! This library is a work in progress. This means a feature you might need is not implemented
2-
//! yet or could be handled better.
3-
//!
41
//! Pull requests are always welcome. See [Contributing](https://github.com/influxdb-rs/influxdb-rust/blob/main/CONTRIBUTING.md) and [Code of Conduct](https://github.com/influxdb-rs/influxdb-rust/blob/main/CODE_OF_CONDUCT.md). For a list of past changes, see [CHANGELOG.md](https://github.com/influxdb-rs/influxdb-rust/blob/main/CHANGELOG.md).
52
//!
63
//! ## Currently Supported Features
74
//!
8-
//! - Reading and Writing to InfluxDB
9-
//! - Optional Serde Support for Deserialization
5+
//! - Reading and writing to InfluxDB
6+
//! - Optional Serde support for deserialization
107
//! - Running multiple queries in one request (e.g. `SELECT * FROM weather_berlin; SELECT * FROM weather_london`)
118
//! - Writing single or multiple measurements in one request (e.g. `WriteQuery` or `Vec<WriteQuery>` argument)
12-
//! - Authenticated and Unauthenticated Connections
9+
//! - Authenticated and unauthenticated connections
1310
//! - `async`/`await` support
14-
//! - `#[derive(InfluxDbWriteable)]` Derive Macro for Writing / Reading into Structs
11+
//! - `#[derive(InfluxDbWriteable)]` derive macro for writing / reading into structs
1512
//! - `GROUP BY` support
1613
//! - Tokio and async-std support (see example below) or [available backends](https://github.com/influxdb-rs/influxdb-rust/blob/main/influxdb/Cargo.toml)
1714
//! - Swappable HTTP backends ([see below](#Choice-of-HTTP-backend))
@@ -60,7 +57,7 @@
6057
//!
6158
//! client.query(weather_readings).await?;
6259
//!
63-
//! // Let's see if the data we wrote is there
60+
//! // Read back all records
6461
//! let read_query = ReadQuery::new("SELECT * FROM weather");
6562
//!
6663
//! let read_result = client.query(read_query).await?;
@@ -69,7 +66,7 @@
6966
//! }
7067
//! ```
7168
//!
72-
//! For further examples, check out the Integration Tests in `tests/integration_tests.rs`
69+
//! For further examples, check out the integration tests in `tests/integration_tests.rs`
7370
//! in the repository.
7471
//!
7572
//! # Choice of HTTP backend
@@ -105,7 +102,7 @@ macro_rules! cargo_toml {
105102
};
106103

107104
(indent=$indent:literal, default-features = false, $firstfeat:literal $(, $feature:literal)*) => {
108-
cargo_toml_private!($indent, "default-features = false,", $firstfeat $(, $feature)*)
105+
cargo_toml_private!($indent, "default-features = false, ", $firstfeat $(, $feature)*)
109106
};
110107
}
111108

0 commit comments

Comments
 (0)