Skip to content

Commit

Permalink
Updated Docs
Browse files Browse the repository at this point in the history
* CHANGELOG, README updated
* Added bare bone CONTRIBUTING
  • Loading branch information
Andrew-Chen-Wang committed Feb 12, 2020
1 parent 602cdce commit 8c35a6f
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 1 deletion.
8 changes: 8 additions & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,14 @@
What’s new in django-cachalot?
==============================

2.2.0
-----

- Adds Django 2.2 and 3.0 support.
- Dropped official support for Python 3.4
- It won't run properly with Travis CI tests on MySQL.
- All Travis CI tests are fully functional.

2.1.0
-----

Expand Down
6 changes: 6 additions & 0 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Thanks for contributing to Django Cachalot!

We appreciate any support in improvements to this system
in performance, erasing dependency errors, or in killing bugs.

When you start a PR or issue, please follow the layout provided.
4 changes: 3 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,9 @@ Quickstart

Cachalot officially supports Python 2.7, 3.4-3.8 and Django 1.11, 2.0-2.2, 3.0 with the databases PostgreSQL, SQLite, and MySQL.

Note: Python 3.4 with MySQL fails on tests. If you're MySQL is configured correctly,
Note 1: Python 3.4 with MySQL fails on tests. If you're MySQL is configured correctly, then it may work.

Note 2: Python 3.5 with Django 1.11 in tests prove to have a performance issue.

Third-Party Cache Comparison
----------------------------
Expand Down

0 comments on commit 8c35a6f

Please sign in to comment.