validate-npm-package-name/README.md

# validate-npm-package-name 

Give me a string and I'll tell you if it's a valid npm package name

## Installation

Download node at [nodejs.org](http://nodejs.org) and install it, if you haven't already.

```sh
npm install validate-npm-package-name --save
```

## Usage

```js
var valid = require("validate-npm-package-name")

validate("some-package")  // => {valid: true}
validate("example.com")   // => {valid: true}
validate("CAPITALS")      // => {valid: true}
validate("under_score")   // => {valid: true}
validate("123numeric")    // => {valid: true}
validate("crazy!")        // => {valid: true}
validate("@npm/thingy")   // => {valid: true}
validate("@jane/foo.js")  // => {valid: true}

validate("")              // => {valid: false, errors:["name length must be greater than zero"]}
validate("ca$h")          // => {valid: false, errors:["name can only contain URL-friendly characters"]}
validate("_flodash")      // => {valid: false, errors:["name cannot start with an underscore"]}

```

## Tests

```sh
npm install
npm test
```

## Dependencies

None

## Dev Dependencies

- [tap](https://github.com/isaacs/node-tap): A Test-Anything-Protocol library


## License

ISC

_Generated by [package-json-to-readme](https://github.com/zeke/package-json-to-readme)_