Merge pull request #40 from jjkester/v0.3.2

v0.3.2

README.md

@@ -1,5 +1,3 @@
-*Since my time is very, very limited at the moment and my personal need for the functionality provided by django-auditlog has gone development might be very slow. However, I am happy to look at pull requests for issues. If you like to be a permanent contributor, please contact me (janjelle [at] jjkester [dot] nl).*
-
 django-auditlog
 ===============
 
@@ -9,14 +7,14 @@ django-auditlog
 
 ```django-auditlog``` (Auditlog) is a reusable app for Django that makes logging object changes a breeze. Auditlog tries to use as much as Python and Django’s built in functionality to keep the list of dependencies as short as possible. Also, Auditlog aims to be fast and simple to use.
 
-Auditlog is created out of the need for a simple Django app that logs changes to models, including the user that changed the models (later referred to as actor). Existing solutions seemed to offer a type of version control, which was not needed and would cause too much overhead.
+Auditlog is created out of the need for a simple Django app that logs changes to models along with the user who made the changes (later referred to as actor). Existing solutions seemed to offer a type of version control, which was found excessive and expensive in terms of database storage and performance.
 
-The core idea of Auditlog is similar to the log from Django’s admin. Unlike the log from Django’s admin (django.contrib.admin) Auditlog is much more flexible and also saves a summary of the changes in JSON format, so changes can be tracked easily.
+The core idea of Auditlog is similar to the log from Django’s admin. Unlike the log from Django’s admin (```django.contrib.admin```) Auditlog is much more flexible. Also, Auditlog saves a summary of the changes in JSON format, so changes can be tracked easily.
 
 Documentation
 -------------
 
-The documentation for ``django-auditlog`` can be found on http://django-auditlog.readthedocs.org.
+The documentation for ```django-auditlog``` can be found on http://django-auditlog.readthedocs.org. The source files are available in the ```docs``` folder.
 
 License
 -------

docs/source/conf.py

@@ -62,7 +62,7 @@ copyright = u'2015, Jan-Jelle Kester'
 # The short X.Y version.
 version = '0.3'
 # The full version, including alpha/beta/rc tags.
-release = '0.3.1'
+release = '0.3.2'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

docs/source/index.rst

@@ -5,9 +5,9 @@ django-auditlog (Auditlog) is a reusable app for Django that makes logging objec
 use as much as Python and Django's built in functionality to keep the list of dependencies as short as possible. Also,
 Auditlog aims to be fast and simple to use.
 
-Auditlog is created out of the need for a simple Django app that logs changes to models, including the user that changed
-the models (later referred to as actor). Existing solutions seemed to offer a type of version control, which was not
-needed and would cause too much overhead.
+Auditlog is created out of the need for a simple Django app that logs changes to models along with the user who made the
+changes (later referred to as actor). Existing solutions seemed to offer a type of version control, which was found
+excessive and expensive in terms of database storage and performance.
 
 The core idea of Auditlog is similar to the log from Django's admin. However, Auditlog is much more flexible than the
 log from Django's admin app (:py:mod:`django.contrib.admin`). Also, Auditlog saves a summary of the changes in JSON
@@ -28,11 +28,12 @@ Contribute to Auditlog
 ----------------------
 
 .. note::
-   Due to multiple reasons the development of Auditlog is not a priority. Therefore progress might be very slow.
-   However, community involvement in the form of pull requests is very much appreciated. If you like to take Auditlog to
-   the next level and be a permanent contributor, please contact the author (janjelle@jjkester.nl).
+   Due to multiple reasons the development of Auditlog is not a priority for me at this moment. Therefore progress might
+   be slow. This does not mean that this project is abandoned! Community involvement in the form of pull requests is
+   very much appreciated. Also, if you like to take Auditlog to the next level and be a permanent contributor, please
+   contact the author. Contact information can be found via GitHub.
 
-If you found an issue with Auditlog or want to improve the code, please submit an issue and/or pull request via GitHub.
+If you discovered a bug or want to improve the code, please submit an issue and/or pull request via GitHub.
 Before submitting a new issue, please make sure there is no issue submitted that involves the same problem.
 
 | GitHub repository: https://github.com/jjkester/django-auditlog

docs/source/installation.rst

@@ -11,11 +11,11 @@ The repository can be found at https://github.com/jjkester/django-auditlog/.
 
 **Requirements**
 
-- Python 2.7 or 3.4
-- Django 1.7 or 1.8
+- Python 2.7, 3.4 or higher
+- Django 1.7 or higher
 
-Auditlog is currently tested with Python 2.7 and 3.4 and Django 1.7 and 1.8. The test report can be found at
-https://travis-ci.org/jjkester/django-auditlog.
+Auditlog is currently tested with Python 2.7 and 3.4 and Django 1.7, 1.8 and 1.9. The latest test report can be found
+at https://travis-ci.org/jjkester/django-auditlog.
 
 Adding Auditlog to your Django application
 ------------------------------------------
@@ -24,4 +24,5 @@ To use Auditlog in your application, just add ``'auditlog'`` to your project's `
 ``manage.py migrate`` to create/upgrade the necessary database structure.
 
 If you want Auditlog to automatically set the actor for log entries you also need to enable the middleware by adding
-``'auditlog.middleware.AuditlogMiddleware'`` to your ``MIDDLEWARE_CLASSES`` setting.
+``'auditlog.middleware.AuditlogMiddleware'`` to your ``MIDDLEWARE_CLASSES`` setting. Please check :doc:`usage` for more
+information.

setup.py

@@ -2,7 +2,7 @@ from distutils.core import setup
 
 setup(
     name='django-auditlog',
-    version='0.3.1',
+    version='0.3.2',
     packages=['auditlog', 'auditlog.migrations'],
     package_dir={'': 'src'},
     url='https://github.com/jjkester/django-auditlog',