From 5784d1324134f7dc20e6347777b33c10671f504e Mon Sep 17 00:00:00 2001
From: Adar Nimrod <nimrod@shore.co.il>
Date: Fri, 30 Dec 2016 17:05:44 +0200
Subject: [PATCH] - Updated documentation, release procedure.
---
README.rst | 11 ++++++-----
tox.ini | 2 +-
2 files changed, 7 insertions(+), 6 deletions(-)
diff --git a/README.rst b/README.rst
index 31bb096..f5af29c 100644
--- a/README.rst
+++ b/README.rst
@@ -51,15 +51,16 @@ Example usage can be seen in :code:`tests.sh`.
Testing
-------
-Local tests require both a Python 2, Python 3 and Tox installed and can be run
-by running :code:`tox`. Alternatively, Travis CI is used to test on multiple
-versions of Python for every push.
+Tests require Python 2.7, Python 3.2 or later and Tox and are run by running
+:code:`tox`. Also, Travis CI is used to test on multiple Python versions for
+every push.
Release
-------
-Currently releases are done locally by running :code:`tox -e release` and
-require Python and Tox installed. Releases with Travis CI are coming.
+Releases require Python 2.7 or Python 3.2 or later and Tox. To release a new
+version bump the version in the :code:`VERSION` file and run :code:`tox -e
+release`.
License
-------
diff --git a/tox.ini b/tox.ini
index 1ac57a8..719a30a 100644
--- a/tox.ini
+++ b/tox.ini
@@ -31,6 +31,6 @@ deps =
twine
wheel
commands =
- sh -c 'git tag -f "$(cat VERSION)"'
+ sh -c 'git tag "$(cat VERSION)" && git push --tags'
python setup.py bdist_wheel
twine upload --skip-existing dist/*.whl
--
GitLab