summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorVal Neekman <val@neekware.com>2014-01-01 13:19:51 -0500
committerVal Neekman <val@neekware.com>2014-01-01 13:19:51 -0500
commitc32786bfe4ec66fbde0f417c9d0feb2b277e76b8 (patch)
treef02c22a0e23d935d4f26453cd8e352da51f6e7ac
parent6d980bafbf9d301b2cbd7aba9e22a795c3fb0a1e (diff)
downloadpython-slugify-c32786bfe4ec66fbde0f417c9d0feb2b277e76b8.tar.gz
moved changedlog out of readme
-rw-r--r--CHANGELOG.md33
-rw-r--r--README.md89
2 files changed, 72 insertions, 50 deletions
diff --git a/CHANGELOG.md b/CHANGELOG.md
new file mode 100644
index 0000000..48ca2c4
--- /dev/null
+++ b/CHANGELOG.md
@@ -0,0 +1,33 @@
+## 0.0.5
+
+Enhancement:
+
+ - Update for smart_truncate
+
+
+## 0.0.4
+
+Features:
+
+ - Added Python 3.2 and 3.3 support
+
+
+## 0.0.3
+
+Features:
+
+ - Added the ability to truncate slugs
+
+
+## 0.0.2
+
+Enhancement:
+
+ - Added more test
+
+
+## 0.0.1
+
+Features:
+
+ - Initial Release
diff --git a/README.md b/README.md
index bdf2c39..7124442 100644
--- a/README.md
+++ b/README.md
@@ -1,17 +1,21 @@
Python Slugify
-====================
+===============
**A Python slugify application that handles unicode**
-**Author:** Val Neekman [ info [@] neekware.com, [@vneekman](https://twitter.com/vneekman) ]
+[![build-status-image-travis]][travis]
+[![build-status-image-fury]][fury]
+[![build-status-image-pypi]][pypi]
+
Overview
========
-A Python slugify application that handles unicode.
+A Python **slugify** application that handles **unicode**.
+
How to install
-==================
+==============
1. easy_install python-slugify
2. pip install python-slugify
@@ -23,18 +27,19 @@ How to install
b. cd into python-slugify-* directory
c. run python setup.py
+
How to use
-=================
+===========
from slugify import slugify
txt = "This is a test ---"
r = slugify(txt)
self.assertEquals(r, "this-is-a-test")
-
+
txt = "This -- is a ## test ---"
r = slugify(txt)
self.assertEquals(r, "this-is-a-test")
-
+
txt = 'C\'est déjà l\'été.'
r = slugify(txt)
self.assertEquals(r, "cest-deja-lete")
@@ -83,6 +88,7 @@ How to use
r = slugify(txt, max_length=20, word_boundary=True, separator="ZZZZZZ")
self.assertEquals(r, "jajaZZZZZZlolZZZZZZmememeooZZZZZZa")
+
Running the tests
=================
@@ -90,60 +96,43 @@ To run the tests against the current environment:
python test.py
-Changelog
-=========
-
-0.0.6
------
-* Update for smart_truncate
-
-0.0.5
------
-* Added Python 3.2/3.3 Support. (work done by: arthurdarcet@github)
-
-0.0.4
------
-* Added option to add a non-dash separator (feature request by: danilodimoia@github)
-0.0.3
------
-* Added the ability to truncate slugs + tests (feature request by:juanriaza@github)
-
-0.0.2
------
-* Added more tests
-
-0.0.1
------
-
-* Initial release
-
-
-License
-=======
+License (BSD)
+====================
Copyright © Val Neekman ([Neekware Inc.](http://neekware.com))
All rights reserved.
-Redistribution and use in source and binary forms, with or without
+Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
-Redistributions of source code must retain the above copyright notice, this
+Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
-Redistributions in binary form must reproduce the above copyright notice, this
-list of conditions and the following disclaimer in the documentation and/or
+Redistributions in binary form must reproduce the above copyright notice, this
+list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution.
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
-ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
-FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
-SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
-CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
-OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+Note: Django is a registered trademark of the Django Software Foundation.
+
+
+[build-status-image-travis]: https://secure.travis-ci.org/un33k/python-slugify.png?branch=master
+[travis]: http://travis-ci.org/tomchristie/python-slugify?branch=master
+
+[build-status-image-fury]: https://badge.fury.io/py/python-slugify.png
+[fury]: http://badge.fury.io/py/python-slugify
+
+[build-status-image-pypi]: https://pypip.in/d/python-slugify/badge.png
+[pypi]: https://crate.io/packages/python-slugify?version=latest