From 43e3f12d84a7eaab619a13cdcd4a4c462a64b9b1 Mon Sep 17 00:00:00 2001 From: James Watts Date: Sun, 28 Jun 2015 02:41:51 +0200 Subject: [PATCH] Updated README --- README.md | 57 +++++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 55 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 586abf5..276aa04 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,55 @@ -# nano-validate -nano validate plugin +nano Validate plugin +==================== + +The **Validate** plugin for the [nano JavaScript framework](http://nanojs.org) adds a method to the API wrapper which provides validation of multiple data types. + +Installation +------------ + +To add the **Validate** plugin include it in the `` of the document, after the core framework: + +```html + + + + My Site + + + + + + + + + +``` + +Documentation +------------- + +Full documentation for the plugin is available at [http://nanojs.org/plugins/validate](http://nanojs.org/plugins/validate). + +Support +------- + +For support, bugs and feature requests, please use the [issues](https://github.com/nanojs/nano-validate/issues) section of this repository. + +Contributing +------------ + +If you'd like to contribute new features, enhancements or bug fixes to the code base just follow these steps: + +* Create a [GitHub](https://github.com/signup/free) account, if you don't own one already +* Then, [fork](https://help.github.com/articles/fork-a-repo) the [nano-validate](https://github.com/nanojs/nano-validate) repository to your account +* Create a new [branch](https://help.github.com/articles/creating-and-deleting-branches-within-your-repository) from the *develop* branch in your forked repository +* Modify the existing code, or add new code to your branch +* When ready, make a [pull request](http://help.github.com/send-pull-requests/) to the main repository + +There may be some discussion regarding your contribution to the repository before any code is merged in, so be prepared to provide feedback on your contribution if required. + +License +------- + +Copyright 2008-2015 James Watts. All rights reserved. + +Licensed under the GNU/GPL. Redistributions of the source code included in this repository must retain the copyright notice found in each file.