Skip to content

Commit

Permalink
[doc] Added some installation notes and link's to the documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
3rd-Eden committed Dec 3, 2012
1 parent 3445273 commit 7cf435c
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions README.md
Expand Up @@ -4,6 +4,32 @@ Creditcard number parsing, validation and information extraction. The source
code has been commented using JSDoc and converted to documentation which can be
found in the `docs` folder.

## Installation

The module is available in the NPM registery. It can be installed using the
`npm` commandline utlity.

```
npm install creditcard
```

Once you have installed the module you can simply require inside of your Node.js
application and use it's exported methods.

```js
var creditcard = require('creditcard');

creditcard.validate(4111111111111);
```

## Documentation

The documentation of this module has been automatically generated from the
JSDocs that is used to comment the source code. It should give a clear
understanding of the methods that are available in this module and how it should
be used. The documentation can be found in the [**docs
folder**](https://github.com/observing/creditcard/tree/master/docs)

### License (MIT)

Copyright (c) 2012 Observe.it (http://observe.it) <opensource@observe.it>
Expand Down

0 comments on commit 7cf435c

Please sign in to comment.