Skip to content

Commit

Permalink
improve readme
Browse files Browse the repository at this point in the history
Signed-off-by: Freyskeyd <[email protected]>
  • Loading branch information
Freyskeyd committed Oct 12, 2017
1 parent f0f612f commit 21c1ede
Show file tree
Hide file tree
Showing 3 changed files with 66 additions and 4 deletions.
10 changes: 7 additions & 3 deletions Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
[package]
name = "environment"
version = "0.1.0"
version = "0.1.1"
authors = ["Freyskeyd <[email protected]>"]
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]
59 changes: 59 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
1 change: 0 additions & 1 deletion src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,6 @@ where
#[cfg(test)]
mod test {
use super::*;
use std::borrow::Cow;
use std::process::Command;

#[test]
Expand Down

0 comments on commit 21c1ede

Please sign in to comment.