Skip to content

Commit d4a4230

Browse files
committed
update read me, documentation does match pypi version
1 parent affb6af commit d4a4230

2 files changed

Lines changed: 15 additions & 5 deletions

File tree

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Running Tests
2121
To run the tests locally, just run `python tests.py`.
2222

2323

24-
./tests.py
24+
python tests.py
2525

2626
You can also pass a name string to `tests.py` to see how it will be parsed.
2727

README.rst

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,11 +44,15 @@ any suggestions for ways the library could be easier to use or modify.
4444
Installation
4545
------------
4646

47-
``pip install nameparser``
47+
.. ``pip install nameparser``
48+
..
49+
.. I usually push changes to `PyPi <https://pypi.python.org/pypi/nameparser>`_
50+
.. pretty quickly. If you want to try out the latest code from GitHub you can
51+
.. install with pip using the command below.
4852
49-
I usually push changes to `PyPi <https://pypi.python.org/pypi/nameparser>`_
50-
pretty quickly. If you want to try out the latest code from GitHub you can
51-
install with pip using the command below.
53+
If you're starting a new project, I recommend installing master from GitHub to give v0.3
54+
a try. It is not backwards compatible with v0.2, but passes all the same tests, and is
55+
easier to configure.
5256

5357
``pip install -e git+git://github.com/derek73/python-nameparser.git#egg=nameparser``
5458

@@ -60,6 +64,12 @@ simple Heroku-friendly Flask wrapper for this module.
6064
Documentation
6165
-------------
6266

67+
**NOTE:** This documentation covers the new **version 0.3** that has yet to be released
68+
to PyPi. For the v0.2.10 documentation, see the `v0.2.10 tag`_ on GitHub.
69+
70+
.. _v0.2.10 tag: https://github.com/derek73/python-nameparser/tree/v0.2.10
71+
72+
6373
http://nameparser.readthedocs.org/en/latest/
6474

6575
Contributing

0 commit comments

Comments
 (0)