From cf6d9a78f19bcbdd55e99afe2e07ac197a7c4265 Mon Sep 17 00:00:00 2001 From: Abhishek Chanda Date: Fri, 24 Apr 2015 14:58:59 -0700 Subject: [PATCH] Add instructions --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index 801048d..05da7db 100644 --- a/README.md +++ b/README.md @@ -1 +1,16 @@ This is supposed to be a library to work with IPv4 and v6 CIDRs in rust + +Installation +============= +This crate works with Cargo. Assuming you have Rust and Cargo installed, simply check out the source and run tests: +``` +git clone https://github.com/achanda/ipnetwork +cd ipnetwork +cargo test +``` + +You can also add `ipnetwork` as a dependency to your project's `Cargo.toml`: +``` +[dependencies.ipnetwork] +ipnetwork = "0.1.1" +```