Improve documentation

* bump version

Author: weiznich

Cargo.toml

@@ -1,10 +1,18 @@
 [package]
 authors = ["Georg Semmler <[email protected]>"]
 name = "crates-mirror"
-version = "0.1.0"
+version = "0.2.0"
 license = "MIT/Apache-2.0"
 description = "Crates.io mirror"
 repository = "https://github.com/weiznich/crates-mirror"
+readme = "README.md"
+keywords = ["crates.io", "mirror"]
+include = [
+    "src/main.rs",
+    "Cargo.toml",
+    "Cargo.lock",
+    "README.md"
+]
 
 [dependencies]
 clap = "2"

README.md

@@ -1,4 +1,4 @@
-# crates-mirror
+# Crates.io caching mirror
 [![Build Status](https://travis-ci.org/weiznich/crates-mirror.svg?branch=master)](https://travis-ci.org/weiznich/crates-mirror)
 
 
@@ -17,24 +17,36 @@ Stores the index localy on the filesystem.
 base_path = "/path/to/store/crates"
 listen_on = "localhost:3000"
 remote_api = "https://crates.io"
-poll_intervall = 60 #seconds
-registry_config = {upstream_url = "https://github.com/rust-lang/crates.io-index"}
+poll_intervall = 300 # seconds
+
+[registry_config]
+upstream_url = "https://github.com/rust-lang/crates.io-index"
 ```
 ### Remote Index
 Stores the index in a remote git repositority.
 ```toml
-base_path = "/path/to/store/crates"
+base_path = "/tmp/crates_mirror"
 listen_on = "localhost:3000"
 remote_api = "https://crates.io"
-poll_intervall = 60 #seconds
-registry_config = {upstream_url = "https://github.com/rust-lang/crates.io-index", origin_url = "[email protected]/whatever"}
+poll_intervall = 300 # seconds
+
+[registry_config]
+upstream_url = "https://github.com/rust-lang/crates.io-index"
+
+[registry_config.origin]
+url = "[email protected]/whatever"
+username = "weiznich" #optional, could also use ssh-key
+password = "xxxxx" #optional, could also use ssh-key
 ```
 
+## Reading Material
+* [Dissecting Crates.io: Bare Minimum Mirror](https://gmjosack.github.io/posts/dissecting-cratesio-minimum-mirror/)
+
 ## 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.
+at your option.