Skip to content

Commit

Permalink
Updated Readme with Client-Side usage as well as the license.
Browse files Browse the repository at this point in the history
  • Loading branch information
JamesEggers1 committed May 29, 2012
1 parent 8ca3da3 commit 56978d7
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 2 deletions.
7 changes: 7 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Copyright (c) 2012 James Eggers

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
28 changes: 26 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,40 @@ Once the package is installed, you can run the unit tests associated with the pa

npm test DateValidator

## Usage ##
## Node Usage ##

DateValidator at the moment provides an object with a single method `validate`. The `validate` method expects a year, month, and day string parameters and will validate based on such.

var date_validator = require("DateValidator").DateValidator;
var is_valid = date_validator.validate("2012", "12", "31"); //true

## Web Usage ##

DateValidator can be used in both Node.js and client-side/Web Browser environments. Below is an example for using the DateValdiator in the web browser.

#### Html ####
<script type="text/javascript" src="path/to/date-validator.js"></script>

#### JavaScript ####
var validator = DateValidator;
var is_valid = date_validator.validate("2012", "12", "31"); //true

By default, the DateValidator module places itself into the global scope in the browser. If you would prefer to NOT have it be directly attached to the `window` object, you can add your own `namespace` at the top of the date-validator.js file.

## False Conditions ##

The `validate` method will return `false` for the following conditions:
- if any parameter is `undefined`
- if any parameter is not numeric
- if any parameter is less than or equal to (<=) 0
- if the month is greater than 12
- if the day is invalid for the provided month (i.e. Feb 31);
- if the day is invalid for the provided month (i.e. Feb 31);

## License ##
Copyright (c) 2012 James Eggers

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

0 comments on commit 56978d7

Please sign in to comment.