Skip to content

Commit a4ad866

Browse files
committed
update readme to match
1 parent e6037ff commit a4ad866

File tree

1 file changed

+27
-4
lines changed

1 file changed

+27
-4
lines changed

README.rst

+27-4
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,31 @@
11
Flask-Inputs
22
============
33

4-
The Flask-Inputs project has three goals:
4+
WTForms is awesome for validating POST data. What about other request data?
55

6-
- Validate incoming request data
7-
- Seperate inputs and business logic
8-
- Better error messages
6+
The **Flask-Inputs** extension adds support for WTForms to validate request data from args to headers to json.
7+
8+
9+
Installation
10+
------------
11+
12+
To install Flask-Inputs, simply::
13+
14+
$ pip install flask-inputs
15+
16+
17+
JSON validation requires `jsonschema <https://pypi.python.org/pypi/jsonschema>`_::
18+
19+
$ pip install jsonschema
20+
21+
22+
Documentation
23+
-------------
24+
25+
Documentation is available at `<http://pythonhosted.org/Flask-Inputs>`_
26+
27+
28+
Contribute
29+
----------
30+
31+
Fork the repository, make changes and add a test which shows that the bug was fixed or that the feature works as expected with 100% coverage. Send a pull request.

0 commit comments

Comments
 (0)