From 31f3917ff5aafa8450087d31acfee9cde49876cf Mon Sep 17 00:00:00 2001 From: James O'Toole Date: Sat, 28 Feb 2015 22:33:30 +0000 Subject: [PATCH] Updated README --- README.md | 29 +++++------------------------ 1 file changed, 5 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 932b396..40faf37 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# WTForms-ParsleyJS +# WTForms-ParsleyJS 2.0 ## What is this? @@ -16,32 +16,13 @@ This library will generate the necesssary HTML attributes from your WTForms vali ## Installation -You can install from [pypi](https://pypi.python.org/pypi/WTForms-ParsleyJS) using +You can install from [pypi](https://pypi.python.org/pypi/WTForms-ParsleyJS) using `pip install wtforms-parsleyjs` ## What is supported? -The following WTForms validators are supported: - -* E-Mail Address -* Matching values -* IP4 Address -* Length of string -* Required field -* Regexp (see limitations) -* URL -* `AnyOf` - -The `NoneOf` validator is not supported because this functionality is not supported by ParsleyJS. - -The following WTForms widgets are supported: - -* TextInput -* Select -* CheckboxInput - -Radio Buttons are not supported. +All validators documented by WTForms are supported, all documented fields are also supported, with the exception of SubmitField. The reason SubmitField is not included is because I see no use case to validate Submit client side. ## How to use it? @@ -67,9 +48,9 @@ WTForms-ParsleyJS has been developed and run solely on Python 2.7 - but it may w ## Dependencies -Of course ParsleyJS and WTForms are required. ParsleyJS in turn requires jQuery. +Of course ParsleyJS and WTForms are required. ParsleyJS in turn requires jQuery. -The `AnyOf` validator requires parsleys extra validators which are distributed in a seperate file. +If you wish to use AnyOf validator, NoneOf validator, DateField or DateTimeField then you need to include their matching ParsleyJS plugins, found in the scripts folder. The sample uses the [Flask web framework](http://flask.pocoo.org/docs/) and [Twitter Bootstrap](http://twitter.github.io/bootstrap/). Because the sample should run out of the box on Heroku, ParsleyJS is included as a git submodule.