Skip to content

Commit 510442b

Browse files
committed
Add install instructions
Added crates badge removed exact python version added -y Added macOS install instructions
1 parent 9ad989d commit 510442b

File tree

1 file changed

+12
-4
lines changed

1 file changed

+12
-4
lines changed

README.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# Rust-HTTP-Server
22
[![Build Status](https://travis-ci.org/asoderman/rust-http-server.svg?branch=master)](https://travis-ci.org/asoderman/rust-http-server)
3+
[![Crates.io](https://img.shields.io/crates/v/rustc-serialize.svg)](https://crates.io/crates/rust-http-server)
34

45
Rust-HTTP-Server is a small multi-threaded webserver that supports TLS and WSGI. Rust-HTTP-Server's goal is to be an easy to use, fast and lightweight http server.
56

@@ -9,12 +10,19 @@ Rust-HTTP-Server is a small multi-threaded webserver that supports TLS and WSGI.
910
* [TODO](#todo)
1011

1112
# Installation:
12-
Currently the only way to install rust-http-server is to download the project and build with cargo. crates.io support is coming soon!
13+
14+
### macOS:
15+
`cargo install rust-http-server` will work as long as you have a homebrew install of python. If you
16+
are still using the python install provided by Apple run `brew reinstall python` first.
17+
18+
### Ubuntu:
19+
This will install system dependencies and then install the server via cargo.
20+
21+
`sudo apt-get install -y pkg-config libssl-dev python3-dev && cargo install rust-http-server`
1322

1423
# Usage:
15-
### With Cargo:
16-
* `cargo run` to start the server
17-
* `cargo run -- -h` for help
24+
* `rust-http-server` to start the server
25+
* `rust-http-server --help` for help
1826
* `cargo test` to run the tests (Note: Openssl must be installed on your system otherwise the TLS test will fail.)
1927

2028
rust-http-server will look for `config.json` in the current working directory. Config options include:

0 commit comments

Comments
 (0)