From 2f100e1dc1e87fa84502672e006a3fb87f172365 Mon Sep 17 00:00:00 2001 From: "Y. T. Chung" Date: Sat, 5 Nov 2016 08:28:06 +0800 Subject: [PATCH] updated readme and rename crate to shadowsocks --- Cargo.toml | 2 +- README.md | 11 ++++++++++- 2 files changed, 11 insertions(+), 2 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index 35ac7d53..e8057611 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "shadowsocks-rust" -version = "0.9.15" +version = "1.0.0" authors = ["Y. T. CHUNG "] description = "shadowsocks is a fast tunnel proxy that helps you bypass firewalls." repository = "https://github.com/zonyitoo/shadowsocks-rust" diff --git a/README.md b/README.md index 36be0c50..c3b507ac 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,7 @@ [![Build Status](https://img.shields.io/travis/zonyitoo/shadowsocks-rust.svg)](https://travis-ci.org/zonyitoo/shadowsocks-rust) [![License](https://img.shields.io/github/license/zonyitoo/shadowsocks-rust.svg)](https://github.com/zonyitoo/shadowsocks-rust) +[![crates.io](https://img.shields.io/crates/v/shadowsocks-rust.svg)](https://crates.io/crates/shadowsocks-rust) This is a port of [shadowsocks](https://github.com/shadowsocks/shadowsocks). @@ -16,7 +17,15 @@ It is **unstable**! If you encounter any problems, please open an issue. ## Usage -Build with [Cargo](http://doc.crates.io): +Install from [crates.io](https://crates.io/crates/shadowsocks-rust): + +```bash +cargo install shadowsocks-rust +``` + +then you can find `sslocal` and `ssserver` in `$CARGO_HOME/bin`. + +or you can also build with [Cargo](http://doc.crates.io): ```bash cargo build