Merge pull request #121 from gergelypolonkai/docs-update

Update documentation

.gitignore

@@ -1,3 +1,4 @@
+/.venv/
 *.py[co]
 .*.swp
 .tox

.pre-commit-config.yaml

@@ -0,0 +1,6 @@
+repos:
+  - repo: https://github.com/python/black
+    rev: stable
+    hooks:
+      - id: black
+        language_version: python3.6

CONTRIBUTORS → AUTHORS

@@ -1,3 +1,11 @@
+Original author:
+thadeusb (Thadeus Burgess)
+
+Maintainers:
+sh4nks (Peter Justin)
+gergelypolonkai (Gergely Polonkai)
+
+Contributors (in no particular order):
 dag (Dag Odenhall)
 sean-
 singingwolfboy (David Baumgold) <david@davidbaumgold.com>
@@ -7,4 +15,3 @@ dahlia (Hong Minhee)
 jab (Joshua Bronson)
 kennethreitz (Kenneth Reitz)
 Thomas Waldmann
-sh4nks (Peter Justin)

CONTRIBUTING.md

@@ -0,0 +1,69 @@
+# How to contribute
+
+The preferred (and easiest) way is to fork the repository, add your changes
+based on the `master` branch and create a pull request.
+
+We use Travis CI for continuous integration so all pull requests are
+automatically tested for all supported Python versions.
+
+# Setting up the project
+
+After cloning the repository you should need to create a Python virtualenv:
+
+    $ cd flask-caching
+    $ python3 -m venv .venv/
+
+This will create a directory `.venv` that you can activate with one of these
+commands (depending on your shell):
+
+    $ source .venv/bin/activate       # for Bash and compatible
+    $ source .venv/bin/activate.csh   # for C shells like CSH or TCSH
+    $ source .venv/bin/activate.fish  # For Fish
+
+The `.venv` directory is on the ignore list, so you can’t accidentally add it
+to version control.
+
+Next, you should install the project’s dependencies:
+
+    $ pip install -r requirements.txt
+
+# Formatting code
+
+To avoid getting a “please reformat/break this line” type of message during
+reviews, you should run the modified files through
+[black](https://github.com/python/black). We usually run it as `black -l 80`,
+but a plain `black` will suffice, too. If you have
+[pre-commit](https://pre-commit.com/) installed, this is done automatically
+for you (just don’t forget to activate it with `pre-commit install`). If you
+don’t, you can install `black` manually using
+
+    $ pip install black
+
+# Writing and running tests
+
+Newly added code should be fully tested; otherwise we won’t merge your pull
+requests.
+
+Running tests is as easy as
+
+    $ pytest
+
+We have the coverage module enabled so you will see your tests’ coverage
+immediately.
+
+If you want to test your changes for other Python versions, install and run `tox`:
+
+    $ pip install tox
+    $ tox              # To run for every supported version
+    $ tox -e py35      # To run only for Python 3.5
+
+# Helping out without writing code
+
+Besides code, we’re happy to accept pull requests to update documentation,
+triage issues, and testing new features before they get merged.
+
+# First-time contributors
+
+If you are a new contributor, look for the [good first
+issue](labels/good+first+issue) label. It marks issues that are easy to solve
+without thoroughly understanding the code base.

README.md

@@ -6,6 +6,7 @@ Flask-Caching
 [![PyPI Version](https://img.shields.io/pypi/v/Flask-Caching.svg)](https://pypi.python.org/pypi/Flask-Caching)
 [![Documentation Status](https://readthedocs.org/projects/flask-caching/badge/?version=latest)](https://flask-caching.readthedocs.io/en/latest/?badge=latest)
 [![License](https://img.shields.io/badge/license-BSD-yellow.svg)](https://github.com/sh4nks/flask-caching)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/python/black)
 
 Adds easy cache support to Flask.