diff --git a/README.md b/README.md index ba9d17d..ed7a79e 100644 --- a/README.md +++ b/README.md @@ -1 +1,14 @@ -**Work in progress** \ No newline at end of file +**Work in progress** + +## Installation + +We're not on npm yet. In your package.json, include this as + +```js +"ppppp-db": "github:staltz/ppppp-db" +``` + +## Usage + +It's a secret-stack plugin much like ssb-db2. Other than that, you can also use +the feed format `const FeedV1 = require('ppppp-db/feed-v1')`. diff --git a/package.json b/package.json index a1c83b4..e26b085 100644 --- a/package.json +++ b/package.json @@ -11,6 +11,10 @@ "engines": { "node": ">=16" }, + "exports": { + ".": "./index.js", + "./feed-v1": "./lib/feed-v1/index.js" + }, "author": "Andre Staltz ", "license": "CC0-1.0", "homepage": "https://github.com/staltz/ppppp-db",