Prepare for Release

Author: Empty2k12

Cargo.toml

@@ -3,6 +3,17 @@ name = "influxdb"
 version = "0.0.1"
 authors = ["Gero Gerke <[email protected]>"]
 edition = "2018"
+description = "InfluxDB Driver for Rust"
+keywords = ["influxdb", "time series database", "influx"]
+license = "MIT"
+license-file = "LICENSE.md"
+readme = "README.md"
+include = ["src/**/*", "tests/**/*", "Cargo.toml", "LICENSE"]
+repository = "https://github.com/Empty2k12/influxdb-rust"
+
+[badges]
+travis-ci = { repository = "Empty2k12/influxdb-rust", branch = "master" }
+coveralls = { repository = "Empty2k12/influxdb-rust", branch = "master", service = "github" }
 
 [dependencies]
 reqwest = "0.9.17"
@@ -15,5 +26,4 @@ serde_json = { version = "1.0", optional = true }
 
 [features]
 use-serde = ["serde", "serde_json"]
-
 default = ["use-serde"]

LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2019 Gero Gerke https://gero.dev/
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.md

@@ -0,0 +1,99 @@
+<div align="center">
+    <br/>
+    <img
+        alt="rust-influxdb"
+        src="https://i.imgur.com/4k7l8XJ.png"
+        width=250px />
+    <br/>
+    <br/>
+    <strong>Unofficial InfluxDB Driver for Rust</strong>
+</div>
+<br/>
+<p align="center">
+    <a href="https://travis-ci.org/Empty2k12/influxdb-rust">
+        <img src="https://travis-ci.org/Empty2k12/influxdb-rust.svg?branch=master" alt='Build Status' />
+    </a>
+    <a href="https://coveralls.io/github/Empty2k12/influxdb-rust?branch=master">
+        <img src="https://coveralls.io/repos/github/Empty2k12/influxdb-rust/badge.svg?branch=master" alt='Coverage Status' />
+    </a>
+    <a href="https://docs.rs/crate/influxdb">
+        <img src="https://docs.rs/influxdb/badge.svg" alt='Documentation Status' />
+    </a>
+    <a href="https://www.rust-lang.org/en-US/">
+        <img src="https://img.shields.io/badge/Made%20with-Rust-orange.svg" alt='Build with Rust' />
+    </a>
+</p>
+
+This library is a work in progress. Although we've been using it in production at [OpenVelo](https://openvelo.org/),
+we're prioritized features that fit our use cases. This means a feature you might need is not implemented
+yet or could be handled better.
+
+Pull requests are always welcome.
+
+## Currently Supported Features
+
+-   Reading and Writing to InfluxDB
+-   Optional Serde Support for Deserialization
+
+## Planned Features
+
+-   Running multiple queries in one request (e.g. `SELECT * FROM weather_berlin; SELECT * FROM weather_london`)
+-   Read Query Builder instead of supplying raw queries
+-   Authentication against InfluxDB
+-   Methods for setting time and time precision in a query
+
+## Quickstart
+
+Add the following to your `Cargo.toml`
+
+```toml
+influxdb = "0.0.1"
+```
+
+For an example with using Serde deserialization, please refer to [serde_integration](crate::integrations::serde_integration)
+
+```rust
+use influxdb::query::InfluxDbQuery;
+use influxdb::client::InfluxDbClient;
+use serde::Deserialize;
+use tokio::runtime::current_thread::Runtime;
+
+// Create a InfluxDbClient with URL `http://localhost:8086`
+// and database name `test`
+let client = InfluxDbClient::new("http://localhost:8086", "test");
+
+// Let's write something to InfluxDB. First we're creating a
+// InfluxDbWriteQuery to write some data.
+// This creates a query which writes a new measurement into a series called `weather`
+let write_query = InfluxDbQuery::write_query("weather")
+    .add_field("temperature", 82);
+
+// Since this library is async by default, we're going to need a Runtime,
+// which can asynchonously run our query.
+// The [tokio](https://crates.io/crates/tokio) crate lets us easily create a new Runtime.
+let mut rt = Runtime::new().expect("Unable to create a runtime");
+
+// To actually submit the data to InfluxDB, the `block_on` method can be used to
+// halt execution of our program until it has been completed.
+let write_result = rt.block_on(client.query(write_query));
+assert!(write_result.is_ok(), "Write result was not okay");
+
+// Reading data is as simple as writing. First we need to create a query
+let read_query = InfluxDbQuery::raw_read_query("SELECT _ FROM weather");
+
+// Again, we're blocking until the request is done
+let read_result = rt.block_on(client.query(read_query));
+
+assert!(read_result.is_ok(), "Read result was not ok");
+
+// We can be sure the result was successful, so we can unwrap the result to get
+// the response String from InfluxDB
+println!("{}", read_result.unwrap());
+```
+
+For further examples, check out the Integration Tests in `tests/integration_tests.rs`
+in the repository.
+
+## License
+
+The MIT License @ Gero Gerke 2019

src/lib.rs

@@ -13,15 +13,20 @@
 //!
 //! # Planned Features
 //!
-//!  * Better support queries like `CREATE`, `DROP` or `ALTER` which need to be sent as `POST` requests
 //!  * Running multiple queries in one request (e.g. `SELECT * FROM weather_berlin; SELECT * FROM weather_london`)
 //!  * Read Query Builder instead of supplying raw queries
 //!  * Authentication against InfluxDB
 //!  * Methods for setting time and time precision in a query
 //!
 //! # Quickstart
 //!
-//! For a example with using Serde deserialization, please refer to [serde_integration](crate::integrations::serde_integration)
+//! Add the following to your `Cargo.toml`
+//!
+//! ```toml
+//! influxdb = "0.0.1"
+//! ```
+//!
+//! For an example with using Serde deserialization, please refer to [serde_integration](crate::integrations::serde_integration)
 //!
 //! ```rust,no_run
 //! use influxdb::query::InfluxDbQuery;