Skip to content

Commit 7a5a217

Browse files
committed
doc(readme): Update documentation
1 parent a171280 commit 7a5a217

1 file changed

Lines changed: 15 additions & 24 deletions

File tree

README.md

Lines changed: 15 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,17 @@
22

33
<div style="margin-bottom:20px;">
44
<div style="line-height:60px">
5-
<a href="https://travis-ci.org/hapinessjs/config.svg?branch=master">
6-
<img src="https://travis-ci.org/hapinessjs/config.svg?branch=master" alt="build" />
5+
<a href="https://travis-ci.org/hapinessjs/error.svg?branch=master">
6+
<img src="https://travis-ci.org/hapinessjs/error.svg?branch=master" alt="build" />
77
</a>
8-
<a href="https://coveralls.io/github/hapinessjs/config?branch=master">
9-
<img src="https://coveralls.io/repos/github/hapinessjs/config/badge.svg?branch=master" alt="coveralls" />
8+
<a href="https://coveralls.io/github/hapinessjs/error?branch=master">
9+
<img src="https://coveralls.io/repos/github/hapinessjs/error/badge.svg?branch=master" alt="coveralls" />
1010
</a>
11-
<a href="https://david-dm.org/hapinessjs/config">
12-
<img src="https://david-dm.org/hapinessjs/config.svg" alt="dependencies" />
11+
<a href="https://david-dm.org/hapinessjs/error">
12+
<img src="https://david-dm.org/hapinessjs/error.svg" alt="dependencies" />
1313
</a>
14-
<a href="https://david-dm.org/hapinessjs/config?type=dev">
15-
<img src="https://david-dm.org/hapinessjs/config/dev-status.svg" alt="devDependencies" />
14+
<a href="https://david-dm.org/hapinessjs/error?type=dev">
15+
<img src="https://david-dm.org/hapinessjs/error/dev-status.svg" alt="devDependencies" />
1616
</a>
1717
</div>
1818
<div>
@@ -39,8 +39,7 @@ Error module based on [boom](https://github.com/hapijs/boom).
3939

4040
* [Using error module](#using-config-module)
4141
* [Yarn or NPM it in your package.json](#yarn-or-npm-it-in-your-packagejson)
42-
* [Standalone](#standalone)
43-
* [Hapiness](#hapiness)
42+
* [Use](#use)
4443
* [Change History](#change-history)
4544
* [Maintainers](#maintainers)
4645
* [License](#license)
@@ -50,36 +49,28 @@ Error module based on [boom](https://github.com/hapijs/boom).
5049
### `yarn` or `npm` it in your `package.json`
5150

5251
```bash
53-
$ npm install --save @hapiness/error
52+
$ npm install --save @hapiness/biim
5453

5554
or
5655

57-
$ yarn add @hapiness/error
56+
$ yarn add @hapiness/biim
5857
```
5958

6059
```javascript
6160
"dependencies": {
6261
"@hapiness/core": "^1.0.0-rc.6",
63-
"@hapiness/error": "^1.0.0-rc.6",
62+
"@hapiness/biim": "^1.0.0-rc.6",
6463
//...
6564
}
6665
//...
6766
```
6867

69-
### Standalone
70-
71-
`./config/default.yml`:
72-
73-
```yaml
74-
my:
75-
config: test
76-
```
77-
68+
### Use
7869

7970
`Node.js Script`:
8071

8172
```javascript
82-
import { Biim } from '@hapiness/error';
73+
import { Biim } from '@hapiness/biim';
8374

8475
Biim.badRequest('my-message', 'some-data', { key: 'bad-request' });
8576
```
@@ -117,6 +108,6 @@ Biim.badRequest('my-message', 'some-data', { key: 'bad-request' });
117108

118109
## License
119110

120-
Copyright (c) 2017 **Hapiness** Licensed under the [MIT license](https://github.com/hapinessjs/config/blob/master/LICENSE.md).
111+
Copyright (c) 2017 **Hapiness** Licensed under the [MIT license](https://github.com/hapinessjs/error/blob/master/LICENSE.md).
121112

122113
[Back to top](#table-of-contents)

0 commit comments

Comments
 (0)