From adfc5fb8432695723f6ff660cf6bbc488e26a208 Mon Sep 17 00:00:00 2001 From: Kenneth Love Date: Tue, 4 Mar 2014 15:17:11 -0800 Subject: [PATCH] Update README.md Closes #112 --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b854700a..406349dc 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ Install from PyPI with `pip`: ## Contributing -Fork, make a change, update the docs, add/update tests, make a pull request. +See our [contribution guide](https://django-braces.readthedocs.org/en/latest/contributing.html) Add yourself to `CONTRIBUTORS.txt` if you want. @@ -30,6 +30,14 @@ All development dependencies are available in `requirements.txt` file. To run the test suite, execute the following in your shell (Django install is required): `py.test tests/ --cov=braces --cov-report=html` +Or test with `tox` if you have `tox` installed. + ## Change Log [Changelog on Read The Docs](https://django-braces.readthedocs.org/en/latest/changelog.html) + +## Use Django 1.4.x? + +`django-braces` 1.4.x will be the last version to officially support Django 1.4.x. Since Django 1.4.x is an LTS, we'll update `django-braces` 1.4.x as needed for bug fixes but it won't receive new functionality unless backporting is 100% painless. + +Our policy going forward is that `django-braces` officially supports the current version of Django and one version each direction (e.g. 1.6.x is current, so 1.5.x, 1.6.x, and 1.7.x are all supported). There won't be any restraints on using other versions of Django, though, but it will be a "buyer beware" situation.