@@ -35,10 +35,8 @@ Unit Tests
3535.. image :: https://travis-ci.org/derek73/python-nameparser.svg
3636 :target: https://travis-ci.org/derek73/python-nameparser
3737
38- Over 100 unit tests with example names.
39- `Start a New Issue <https://github.com/derek73/python-nameparser/issues >`_
40- for names that fail and I will try to fix it. Let me know if you have
41- any suggestions for ways the library could be easier to use or modify.
38+ Over 100 unit tests with example names. `Start a New Issue `_
39+ for names that fail and I will try to fix it.
4240
4341
4442Installation
@@ -51,7 +49,8 @@ Installation
5149.. install with pip using the command below.
5250
5351 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
52+ a try. Customizing it is not backwards compatible with v0.2.10 (the current version on
53+ pypi) because the configuration layout chagned, but passes all the same tests, and is
5554easier to configure.
5655
5756``pip install -e git+git://github.com/derek73/python-nameparser.git#egg=nameparser ``
@@ -75,10 +74,22 @@ http://nameparser.readthedocs.org/en/latest/
7574Contributing
7675------------
7776
77+ If you come across name piece that you think should be in the default config, you're
78+ probably right. `Start a New Issue `_ and we can get them added.
79+
80+ Or, use GitHub's nifty
81+ web interface to add your new pieces directly to the config files and create a pull
82+ request all in one go, no fork needed. As an example, `click here to propose changes to
83+ the titles `_ config.
84+
7885Please let me know if there are ways this library could be restructured to make
79- it easier for you to use in your projects. Read CONTRIBUTING.md _ for more info.
86+ it easier for you to use in your projects. Read CONTRIBUTING.md _ for more info
87+ on running the tests and contributing to the project.
8088
81- https://github.com/derek73/python-nameparser
89+ ** GitHub Project **
8290
83- .. _ CONTRIBUTING.md : https://github.com/derek73/python-nameparser/tree/master/CONTRIBUTING.md
91+ https://github.com/derek73/python-nameparser
8492
93+ .. _CONTRIBUTING.md : https://github.com/derek73/python-nameparser/tree/master/CONTRIBUTING.md
94+ .. _Start a New Issue : https://github.com/derek73/python-nameparser/issues
95+ .. _click here to propose changes to the titles : https://github.com/derek73/python-nameparser/edit/master/nameparser/config/titles.py
0 commit comments