diff options
| author | Val Neekman <un33kvu@gmail.com> | 2019-03-03 12:40:56 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-03-03 12:40:56 -0500 |
| commit | b8be7d69119dcceb9a3e0ce64a509415737190ac (patch) | |
| tree | 33d4a7f7bc921c33ccd521951881e2efb89dea26 /README.md | |
| parent | 1340320455f7201117ac3970c0facf5d1e0f8767 (diff) | |
| download | python-slugify-3.0.0.tar.gz | |
Promote text-unidecode to primary decoding api (#73)3.0.0
* enable raw re pattern
* conditional text_unidecode install
* update readme, changelog, manifest
* update ci
* readme
* drop test for py 2.6 and 3.3
* clean up readme
* readme
* add support user-specific replacements (#66)
thx
* clean up, up version
* add text-unidecode option as extra
* Upgrade Unidecode, add text-unidecode as extra option (#71)
* Add replacements option (#67)
* add text-unidecode option as extra
* remove req.txt files
* Optional Extra Requirements (#72)
* Add replacements option (#67)
* Upgrade Unidecode, add text-unidecode as extra option (#71)
* Add replacements option (#67)
* add text-unidecode option as extra
* remove req.txt files
* use text-unidecode as primary decoding package
* add dev reqs
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 18 |
1 files changed, 5 insertions, 13 deletions
@@ -15,24 +15,16 @@ Overview Notice ==================== -By default, this modules installs and uses [Unidecode](https://github.com/avian2/unidecode) *(GPL)* for its decoding needs. However if you wish to use [text-unidecode](https://github.com/kmike/text-unidecode) *(GPL & Perl Artistic)* instead, please ensure it is installed prior to `python-slugify` installation. +This module, by default installs and uses [text-unidecode](https://github.com/kmike/text-unidecode) *(GPL & Perl Artistic)* for its decoding needs. -In cases where both `Unidecode` and `text-unidecode` are installed, `Unidecode` is used as the default decoding module. +However, there is an alternative decoding package called [Unidecode](https://github.com/avian2/unidecode) *(GPL)*. It can be installed as `python-slugify[unidecode]` for those who prefer it. How to install ==================== - - 1. easy_install python-slugify - 2. pip install python-slugify - 3. git clone http://github.com/un33k/python-slugify - a. cd python-slugify - b. python setup.py install - 4. wget https://github.com/un33k/python-slugify/zipball/master - a. unzip the downloaded file - b. cd python-slugify-* - c. python setup.py install - + easy_install python-slugify |OR| easy_install python-slugify[unidecode] + -- OR -- + pip install python-slugify |OR| pip install python-slugify[unidecode] How to use ==================== |