Release 1.3.1: Improved documentation

CHANGELOG.yml

@@ -1,5 +1,9 @@
 # Semantic changelog: https://github.com/c4s4/changelog
 
+- version: 1.3.1
+  date:    2015-07-29
+  summary: Improved documentation
+
 - version: 1.3.0
   date:    2015-07-29
   summary: Added configuration file

README.md

@@ -4,12 +4,41 @@ CheeseShop
 - Project: <https://github.com/c4s4/cheeseshop>
 - Downloads: <https://github.com/c4s4/cheeseshop/releases>
 
-CheeseShop is a Python package repository.
+CheeseShop is a Python package repository. This is a local version of the well-known <http://pypi.python.org>. This is useful for enterprise users that need to share private Python libraries among developers.
+
+To tell PIP where is your private CheeseShop, you must edit you *~/.pip/pip.conf* file:
+
+    [global]
+    index-url = http://my.shop.host:8000/simple
+
+Where *my.shop.host* is the hostname of the machine running CheeseShop. PIP will call your CheeseShop to get packages. If CheeseShop doesn't host this package it will redirect PIP to standard Pypi.
+
+To tell *setup.py* where to upload your package, you must edit file *~/.pypirc*:
+
+    [distutils]
+    index-servers =
+        pypi
+        cheeseshop
+
+    [pypi]
+    username: ***
+    password: ***
+
+    [cheeseshop]
+    username: spam
+    password: foo
+    repository: http://my.shop.host:8000/simple/
+
+*setup.py* will call your CheeseShop if you tell it to use *cheeseshop* connection with following command line:
+
+    $ python setup.py sdist upload -r cheeseshop
+
+Where `-r cheeseshop` is the option that indicates the connection you want to use. There must be a corresponding entry in your *~/.pypirc* configuration file. Don't forget to add *cheeseshop* in the *index-server* list at the beginning of the file.
 
 Installation
 ------------
 
-Download binary archive at <https://github.com/c4s4/cheeseshop/releases>, unzip it and copy the binary executable for your platform (named *cheeseshop-system-platform* in the *bin* directory) somewhere in yout *PATH* and rename it *cheeseshop*. This executable doesn't need any dependency or virtual machine to run.
+Download binary archive at <https://github.com/c4s4/cheeseshop/releases>, unzip it and copy the binary executable for your platform (named *cheeseshop-system-platform* in the *bin* directory) somewhere in your *PATH* and rename it *cheeseshop*. This executable doesn't need any dependency or virtual machine to run.
 
 There are binaries for following platforms:
 
@@ -87,4 +116,21 @@ And to disable start at boot:
 
     $ sudo update-rc.d -f cheeseshop remove
 
+Build CheeseShop
+----------------
+
+To build CheeseShop, you must install [Goyaml](http://github.com/go-yaml/yaml) and [GOX](http://github.com/mitchellh/gox) with following commands:
+
+    $ go get gopkg.in/yaml.v2
+    $ go get github.com/mitchellh/gox
+    $ gox -build-toolchain
+
+Then you can use the make file to build the binary version for your platform:
+
+    $ make build
+
+To build binaries for all platforms, type:
+
+    $ make compile
+
 *Enjoy!*