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

Commit 9b8decb

Browse files
committed
Added build status
1 parent 2ef3ffc commit 9b8decb

1 file changed

Lines changed: 7 additions & 4 deletions

File tree

README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22

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

5-
###Install
5+
##Install
66
`npm install project-name-generator --save`
77

8-
###Quick Start
8+
##Quick Start
99
```
1010
var generate = require('project-name-generator').generate;
1111
@@ -20,7 +20,7 @@ generate(true).dashed; // 'pithy-willow-7794'
2020
generate(true).raw; // ['gentle', 'guru', 621]
2121
```
2222

23-
###API
23+
##API
2424
The module returns an object with a single method `generate(addNumberSuffix)`
2525

2626
Calling `generate()` with no arguments will return an object:
@@ -42,10 +42,13 @@ So `generate(true)` will return:
4242
}
4343
```
4444

45-
###Tests
45+
##Tests
4646
To run tests locally:
4747
```
4848
npm install
4949
5050
npm test
5151
```
52+
53+
##Build Status
54+
![Build status](https://codeship.com/projects/c049a9a0-7fa1-0132-a98e-66b1976afe6a/status?branch=master)

0 commit comments

Comments
 (0)