v0.1.5: Improve documentation

We're making this release mostly to update the package metadata on crates.io with useful documentation and links. It provides no new features, so there's no need to upgrade from v0.1.4 if you already have it.
faradayio · Oct 20, 2017 · 282cbb7 · 282cbb7
1 parent a0b39f7
commit 282cbb7
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 2 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,12 +1,13 @@
 [package]
 name = "geochunk"
-version = "0.1.4"
+version = "0.1.5"
 authors = ["Eric Kidd <git@randomhacks.net>"]
 
 description = "Split a CSV semi-evenly based on ZIP population stats"
 license = "MIT/Apache-2.0"
 readme = "README.md"
 repository = "https://github.com/faradayio/geochunk"
+homepage = "http://blog.faraday.io/geochunk-fast-intelligent-splitting-for-piles-of-address-data/"
 
 [dev-dependencies]
 cli_test_dir = "0.1.2"

diff --git a/README.md b/README.md
@@ -2,6 +2,14 @@
 
 `geochunk` is intended for use in a distributed system.  It provides a deterministic mapping from zip codes to "geochunks" that you can count on remaining stable.  Geochunks will try to approximate the population size that you specify.
 
+See [this blog post on geochunk][blog] for an introduction and some pretty pictures.
+
+[blog]: http://blog.faraday.io/geochunk-fast-intelligent-splitting-for-piles-of-address-data/
+
+## Usage
+
+Run `geochunk --help` for usage instructions.
+
 ```
 geochunk - Partition data sets by estimated population.