diff --git a/README.md b/README.md index 7f81a08..15f9e3d 100644 --- a/README.md +++ b/README.md @@ -1,28 +1,47 @@ -# Rippledb +# [Rippledb](https://rippledb.github.io/) · GitHub Actions status Coverage status npm version Join the chat at https://gitter.im/heineiuo/rippledb -

- GitHub Actions status - Coverage status - npm version - Join the chat at https://gitter.im/heineiuo/rippledb -

+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' } @@ -30,25 +49,10 @@ 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