summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorVal Neekman <val@neekware.com>2019-02-26 11:37:59 -0500
committerVal Neekman <val@neekware.com>2019-02-26 11:37:59 -0500
commitf98b091655824376327c6fa89c25c60e93e03de3 (patch)
tree9d9d5b22778d0a2254c250f1c71ce7143abf5f7e /README.md
parent33d45a6c7ec3e3629bd45582cf65677beea1cf6c (diff)
downloadpython-slugify-f98b091655824376327c6fa89c25c60e93e03de3.tar.gz
use text-unidecode as primary decoding package
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 6 insertions, 13 deletions
diff --git a/README.md b/README.md
index 8d0ce73..13c94a7 100644
--- a/README.md
+++ b/README.md
@@ -15,23 +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, you must
-install it as `python-slugify[text-unidecode]`.
+This module, by default installs and uses [text-unidecode](https://github.com/kmike/text-unidecode) *(GPL & Perl Artistic)* for its decoding needs.
+
+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
====================