Skip to content
This repository was archived by the owner on Sep 30, 2023. It is now read-only.

Commit 3d39211

Browse files
committed
Update README and package.json
1 parent 0959cf8 commit 3d39211

File tree

2 files changed

+21
-2
lines changed

2 files changed

+21
-2
lines changed

package.json

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,21 @@
33
"version": "1.4.0",
44
"description": "Eventlog for orbit-db",
55
"main": "src/EventStore.js",
6+
"homepage": "https://github.com/orbitdb/orbit-db-eventstore",
7+
"bugs": "https://github.com/orbitdb/orbit-db-eventstore/issues",
8+
"repository": {
9+
"type": "git",
10+
"url": "https://github.com/orbitdb/orbit-db-eventstore"
11+
},
612
"scripts": {
713
"test": "echo \"Error: no test specified\" && exit 1",
814
"lint": "standard"
915
},
16+
"keywords": [
17+
"orbitdb",
18+
"orbit-db",
19+
"eventstore"
20+
],
1021
"author": "Haad",
1122
"license": "MIT",
1223
"dependencies": {

readme.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
# orbit-db-eventstore
22

33
[![npm version](https://badge.fury.io/js/orbit-db-eventstore.svg)](https://badge.fury.io/js/orbit-db-eventstore)
4+
[![Gitter](https://img.shields.io/gitter/room/nwjs/nw.js.svg)](https://gitter.im/orbitdb/Lobby)
5+
6+
> Append-Only Log database for orbit-db
47
58
An append-only log with traversable history. Useful for *"latest N"* use cases or as a message queue.
69

@@ -15,7 +18,10 @@ Used in [orbit-db](https://github.com/haadcode/orbit-db).
1518
- [License](#license)
1619

1720
## Install
18-
```
21+
22+
This project uses [npm](https://npmjs.com) and [nodejs](https://nodejs.org)
23+
24+
```sh
1925
npm install orbit-db ipfs
2026
```
2127

@@ -62,7 +68,9 @@ See [orbit-db's API Documenations](https://github.com/haadcode/orbit-db/blob/mas
6268

6369
## Contributing
6470

65-
See [orbit-db's contributing guideline](https://github.com/haadcode/orbit-db#contributing).
71+
If you think this could be better, please [open an issue](https://github.com/orbitdb/orbit-db-eventstore/issues/new)!
72+
73+
Please note that all interactions in @orbitdb fall under our [Code of Conduct](CODE_OF_CONDUCT.md).
6674

6775
## License
6876

0 commit comments

Comments
 (0)