Skip to content
This repository has been archived by the owner on May 1, 2023. It is now read-only.

Commit

Permalink
Added build status
Browse files Browse the repository at this point in the history
  • Loading branch information
aceakash committed Jan 16, 2015
1 parent 2ef3ffc commit 9b8decb
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@

Generate quirky names like "spiffy-waterfall", "sassy-bread", "mature-dew-8239" to use wherever you need a random but memorable name.

###Install
##Install
`npm install project-name-generator --save`

###Quick Start
##Quick Start
```
var generate = require('project-name-generator').generate;
Expand All @@ -20,7 +20,7 @@ generate(true).dashed; // 'pithy-willow-7794'
generate(true).raw; // ['gentle', 'guru', 621]
```

###API
##API
The module returns an object with a single method `generate(addNumberSuffix)`

Calling `generate()` with no arguments will return an object:
Expand All @@ -42,10 +42,13 @@ So `generate(true)` will return:
}
```

###Tests
##Tests
To run tests locally:
```
npm install
npm test
```

##Build Status
![Build status](https://codeship.com/projects/c049a9a0-7fa1-0132-a98e-66b1976afe6a/status?branch=master)

0 comments on commit 9b8decb

Please sign in to comment.