add github action badge

README.md

@@ -1,5 +1,4 @@
-Django Uuslug
-====================
+# Django Uuslug
 
 **A Django slugify application that guarantees `Uniqueness` and handles `Unicode`**
 
@@ -7,13 +6,11 @@ Django Uuslug
 [![version-image]][version-link]
 [![coverage-image]][coverage-link]
 
-Overview
-========
+# Overview
 
-In short: UUSlug == (``U``nique + ``U``nicode) Slug
+In short: UUSlug == (`U`nique + `U`nicode) Slug
 
-How to install
-==================
+# How to install
 
     1. easy_install django-uuslug
     2. pip install django-uuslug
@@ -26,10 +23,9 @@ How to install
         c. run python setup.py
     5. pip install -e git+https://github.com/un33k/django-uuslug#egg=django-uuslug
 
-How to use
-=================
+# How to use
 
-   ```python
+```python
 
  ####### Unicode Test #######
 
@@ -203,44 +199,36 @@ How to use
      def save(self, *args, **kwargs):
          self.slug = uuslug(self.name, instance=self)
          super(SmartTruncatedSlug, self).save(*args, **kwargs)
-   ```
+```
 
-Running the tests
-=================
+# Running the tests
 
 To run the tests against the current environment:
 
     python manage.py test
 
-
-License
-====================
+# License
 
 Released under a ([BSD](LICENSE.md)) license.
 
+# Version
 
-Version
-====================
 X.Y.Z Version
 
     `MAJOR` version -- when you make incompatible API changes,
     `MINOR` version -- when you add functionality in a backwards-compatible manner, and
     `PATCH` version -- when you make backwards-compatible bug fixes.
 
-[status-image]: https://secure.travis-ci.org/un33k/django-uuslug.png?branch=master
-[status-link]: http://travis-ci.org/un33k/django-uuslug?branch=master
-
+[status-image]: https://github.com/un33k/django-uuslug/actions/workflows/main.yml/badge.svg
+[status-link]: https://github.com/un33k/django-uuslug/actions/workflows/main.yml
+[status-image]: https://github.com/un33k/django-uuslug/actions/workflows/main.yml/badge.svg
 [version-image]: https://img.shields.io/pypi/v/django-uuslug.svg
 [version-link]: https://pypi.python.org/pypi/django-uuslug
-
 [coverage-image]: https://coveralls.io/repos/un33k/django-uuslug/badge.svg
 [coverage-link]: https://coveralls.io/r/un33k/django-uuslug
-
 [download-image]: https://img.shields.io/pypi/dm/django-uuslug.svg
 [download-link]: https://pypi.python.org/pypi/django-uuslug
 
-
-Sponsors
-====================
+# Sponsors
 
 [Neekware Inc.](https://github.com/neekware)

requirements.txt

@@ -0,0 +1,2 @@
+Django>=2.2
+python-slugify>=5.0.1