Skip to content

Commit

Permalink
tweak readme, add npm and node badges
Browse files Browse the repository at this point in the history
  • Loading branch information
ralphtheninja committed May 13, 2018
1 parent b002756 commit f80d1b7
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 25 deletions.
47 changes: 22 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,56 +3,53 @@
> Error module for [levelup][levelup]
[![level badge][level-badge]](https://github.com/level/awesome)
[![npm](https://img.shields.io/npm/v/level-errors.svg)](https://www.npmjs.com/package/level-errors)
![Node version](https://img.shields.io/node/v/level-errors.svg)
[![Build Status](https://travis-ci.org/Level/errors.svg)](https://travis-ci.org/Level/errors)
[![dependencies](https://david-dm.org/Level/level.svg)](https://david-dm.org/level/level)
[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
[![npm](https://img.shields.io/npm/dm/level-errors.svg)](https://www.npmjs.com/package/level-errors)

## API

### .LevelUPError()
### `.LevelUPError()`

Generic error base class.
Generic error base class.

### .InitializationError()
### `.InitializationError()`

Error initializing the database, like when the database's location argument is missing.
Error initializing the database, like when the database's location argument is missing.

### .OpenError()
### `.OpenError()`

Error opening the database.
Error opening the database.

### .ReadError()
### `.ReadError()`

Error reading from the database.
Error reading from the database.

### .WriteError()
### `.WriteError()`

Error writing to the database.
Error writing to the database.

### .NotFoundError()
### `.NotFoundError()`

Data not found error.
Data not found error.

Has extra properties:
Has extra properties:

- `notFound`: `true`
- `status`: 404
- `notFound`: `true`
- `status`: 404

### .EncodingError()
### `.EncodingError()`

Error encoding data.
Error encoding data.

## Publishers
## License

* [@ralphtheninja](https://github.com/ralphtheninja)
* [@juliangruber](https://github.com/juliangruber)
Copyright © 2012-2018 `level-errors` contributors.

## License & copyright

Copyright (c) 2012-2017 LevelUP contributors.

LevelUP is licensed under the MIT license. All rights not explicitly granted in the MIT license are reserved. See the included LICENSE.md file for more details.
`level-errors` is licensed under the MIT license. All rights not explicitly granted in the MIT license are reserved. See the included `LICENSE.md` file for more details.

[level-badge]: http://leveldb.org/img/badge.svg
[levelup]: https://github.com/level/levelup
3 changes: 3 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,9 @@
"errno": "~0.1.1"
},
"license": "MIT",
"engines": {
"node": ">=4"
},
"devDependencies": {
"standard": "^11.0.0",
"tape": "^4.3.0"
Expand Down

0 comments on commit f80d1b7

Please sign in to comment.