Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

update README style #11

Merged
merged 2 commits into from
Dec 13, 2017
Merged

update README style #11

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2c044b9
update README style
ralphtheninja Dec 13, 2017
85fc4ca
usage moved to level
ralphtheninja Dec 13, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 8 additions & 19 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,26 +1,12 @@

# level-errors

<img alt="LevelDB Logo" height="100" src="http://leveldb.org/img/logo.svg">

> Error module for [LevelUP](https://github.com/rvagg/node-levelup)
> Error module for [levelup][levelup]

[![Build Status](https://travis-ci.org/Level/errors.png)](https://travis-ci.org/Level/errors)
[![level badge][level-badge]](https://github.com/level/awesome)
[![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)
[![Greenkeeper badge](https://badges.greenkeeper.io/Level/errors.svg)](https://greenkeeper.io/)

## Usage

```js
const levelup = require('levelup')
const errors = levelup.errors

levelup('./db', { createIfMissing: false }, function (err, db) {
if (err instanceof errors.OpenError) {
console.log('open failed because expected db to exist')
}
})
```
[![npm](https://img.shields.io/npm/dm/level-errors.svg)](https://www.npmjs.com/package/level-errors)

## API

Expand Down Expand Up @@ -67,3 +53,6 @@ levelup('./db', { createIfMissing: false }, function (err, db) {
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-badge]: http://leveldb.org/img/badge.svg
[levelup]: https://github.com/level/levelup