Skip to content

Commit

Permalink
Update README.md (#139)
Browse files Browse the repository at this point in the history
  • Loading branch information
heineiuo authored Jul 6, 2020
1 parent fef2c15 commit 50592ac
Showing 1 changed file with 36 additions and 32 deletions.
68 changes: 36 additions & 32 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,54 +1,58 @@
# Rippledb
# [Rippledb](https://rippledb.github.io/) &middot; <a href="https://github.com/heineiuo/rippledb/actions"><img style="max-width:100%" alt="GitHub Actions status" src="https://github.com/heineiuo/rippledb/workflows/Node%20CI/badge.svg"></a> <a href="https://coveralls.io/github/heineiuo/rippledb"><img style="max-width:100%" alt="Coverage status" src="https://coveralls.io/repos/github/heineiuo/rippledb/badge.svg"></a> <a href="https://www.npmjs.com/package/rippledb"><img style="max-width:100%" alt="npm version" src="https://img.shields.io/npm/v/rippledb.svg?style=flat"></a> <a href="https://gitter.im/heineiuo/rippledb?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge"><img style="max-width:100%" alt="Join the chat at https://gitter.im/heineiuo/rippledb" src="https://badges.gitter.im/heineiuo/rippledb.svg"></a>


<p>
<a href="https://github.com/heineiuo/rippledb/actions"><img style="max-width:100%" alt="GitHub Actions status" src="https://github.com/heineiuo/rippledb/workflows/Node%20CI/badge.svg"></a>
<a href="https://coveralls.io/github/heineiuo/rippledb"><img style="max-width:100%" alt="Coverage status" src="https://coveralls.io/repos/github/heineiuo/rippledb/badge.svg"></a>
<a href="https://www.npmjs.com/package/rippledb"><img style="max-width:100%" alt="npm version" src="https://img.shields.io/npm/v/rippledb.svg?style=flat"></a>
<a href="https://gitter.im/heineiuo/rippledb?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge"><img style="max-width:100%" alt="Join the chat at https://gitter.im/heineiuo/rippledb" src="https://badges.gitter.im/heineiuo/rippledb.svg"></a>
</p>
Rippledb is an embeddable key-value database engine in pure TypeScript, based on LSM-Tree, Inspired by LevelDB.

Embeddable key-value database engine in pure TypeScript, based on LSM-Tree, Inspired by LevelDB.
* **Pure TypeScript:** Rippledb is totally written in TypeScript, and runs on different
platforms after being compiled to JavaScript.
* **Lightweight:** Rippledb has only 7k+ source code, and smaller than 1MB after compiled.Rippledb use zero third party modules.
* **Embeddable:** Rippledb can be embedded in node.js application (or other JavaScript Runtime Environments) very easily.

## Get started

Use in JavaScript or TypeScript:
## Installation

```js
const path = require('path')
const { Database } = require('rippledb') // install from npm
Install with npm:

```
npm install rippledb
```

Install with Yarn:

```
yarn add rippledb
```


## Documentation

You can find the React documentation on the [website](https://rippledb.github.io).

Check out the [Get Started](https://rippledb.github.io/docs/) page for a quick overview.


## Examples

```ts
import path from 'path'
import { Database } from 'rippledb'

async function main(){
const db = new Database(path.resolve(__dirname, './db'))
await db.put('foo', 'bar')
console.log(
(await db.get('foo')).toString()
new TextDecorder().decode(await db.get('foo'))
) // 'bar'
}

main()
```


For more details, see [documention](./docs/API.md)


## Roadmap
- [x] TableBuilder
- [x] TableReader
- [x] TableCache
- [x] LogWriter
- [x] LogReader
- [x] WriteBatch
- [x] MemTable
- [x] Database Recovery
- [x] Version Manager
- [x] Compaction
- [x] Operator API (put, get, del, batch, iterator, ok)
- [x] Compaction API (compactRange)
- [x] Snapshot API (getSnapshot, releaseSnapshot)
- [x] Close API (close)
- [x] DBRepair

- [x] Release 1.0 (2020-07-07)
- [ ] Support [Deno](https://deno.land) (2020-9-1)

## Benchmark

Expand Down

0 comments on commit 50592ac

Please sign in to comment.