From 21c1ede5f42eab72a8101209a248f2f00d08e8ba Mon Sep 17 00:00:00 2001 From: Freyskeyd Date: Thu, 12 Oct 2017 13:43:48 +0200 Subject: [PATCH] improve readme Signed-off-by: Freyskeyd --- Cargo.toml | 10 ++++++--- README.md | 59 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ src/lib.rs | 1 - 3 files changed, 66 insertions(+), 4 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index 9007166..7226d36 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,9 +1,13 @@ [package] name = "environment" -version = "0.1.0" +version = "0.1.1" authors = ["Freyskeyd "] description = "Helper to deal with environment variables." -license = "MIT" - +license = "MIT OR Apache-2.0" +repository = "https://github.com/Freyskeyd/environment.git" +homepage = "https://github.com/Freyskeyd/environment" +documentation = "http://docs.rs/environment/" +readme = "README.md" +keywords = ["environment", "env"] [dependencies] diff --git a/README.md b/README.md index e69de29..ca0250c 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,59 @@ +# Environment + +> **Handle environment variable context** - This crate helps you to deal with environment variables. + +[![Build Status](https://travis-ci.org/Freyskeyd/environment.svg)](https://travis-ci.org/Freyskeyd/environment) [![Documentation](https://img.shields.io/badge/docs-master-blue.svg)][Documentation] + +## Install + +Just add it to your `Cargo.toml`: + +```toml +[dependencies] +environment = "0.1" +``` + +## Example + +Here's a trivial example: + +```rust +extern crate environment; + +use std::process::Command; + +fn main() { + let env = Environment::inherit().insert("foo", "bar"); + + + let mut c = Command::new("printenv"); + + let output = c.env_clear() + .envs(env.compile()) + .output() + .expect("failed to execute command"); + + let output = String::from_utf8_lossy(&output.stdout); + + assert!(output.contains("foo=bar")); + +} +``` + +## License + +Licensed under either of + + * Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0) + * MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT) + +at your option. + +### Contribution + +Unless you explicitly state otherwise, any contribution intentionally +submitted for inclusion in the work by you, as defined in the Apache-2.0 +license, shall be dual licensed as above, without any additional terms or +conditions. + +[Documentation]: https://docs.rs/environment diff --git a/src/lib.rs b/src/lib.rs index b4e7528..bc0e97c 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -125,7 +125,6 @@ where #[cfg(test)] mod test { use super::*; - use std::borrow::Cow; use std::process::Command; #[test]