mirror of https://codeberg.org/pzp/pzp-db.git
better readme
This commit is contained in:
parent
18b9c230d6
commit
9ee6bd6d47
13
README.md
13
README.md
|
@ -1 +1,14 @@
|
||||||
**Work in progress**
|
**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')`.
|
||||||
|
|
|
@ -11,6 +11,10 @@
|
||||||
"engines": {
|
"engines": {
|
||||||
"node": ">=16"
|
"node": ">=16"
|
||||||
},
|
},
|
||||||
|
"exports": {
|
||||||
|
".": "./index.js",
|
||||||
|
"./feed-v1": "./lib/feed-v1/index.js"
|
||||||
|
},
|
||||||
"author": "Andre Staltz <contact@staltz.com>",
|
"author": "Andre Staltz <contact@staltz.com>",
|
||||||
"license": "CC0-1.0",
|
"license": "CC0-1.0",
|
||||||
"homepage": "https://github.com/staltz/ppppp-db",
|
"homepage": "https://github.com/staltz/ppppp-db",
|
||||||
|
|
Loading…
Reference in New Issue