diff --git a/README.md b/README.md index 0655025..8a44d71 100644 --- a/README.md +++ b/README.md @@ -175,15 +175,24 @@ LOG=debug node <file> ## Background -OrbitDB uses an append-only log as its operations log, implemented in [ipfs-log](https://github.com/haadcode/ipfs-log). +Uses the following modules: + +- [ipfs-log](https://github.com/orbitdb/ipfs-log) +- [crdts](https://github.com/orbitdb/crdts) +- [orbit-db-cache](https://github.com/orbitdb/orbit-db-cache) +- [orbit-db-store](https://github.com/orbitdb/orbit-db-store) +- [orbit-db-eventstore](https://github.com/orbitdb/orbit-db-eventstore) +- [orbit-db-feedstore](https://github.com/orbitdb/orbit-db-feedstore) +- [orbit-db-kvstore](https://github.com/orbitdb/orbit-db-kvstore) +- [orbit-db-docstore](https://github.com/orbitdb/orbit-db-docstore) +- [orbit-db-counterstore](https://github.com/orbitdb/orbit-db-counterstore) +- [orbit-db-pubsub](https://github.com/orbitdb/orbit-db-pubsub) +- [orbit-db-keystore](https://github.com/orbitdb/orbit-db-keystore) +- [ipfs](https://github.com/ipfs/js-ipfs) +- [ipfs-pubub-room](https://github.com/ipfs-shipyard/ipfs-pubsub-room) To understand a little bit about the architecture, check out a visualization of the data flow at https://github.com/haadcode/proto2 or a live demo: http://celebdil.benet.ai:8080/ipfs/Qmezm7g8mBpWyuPk6D84CNcfLKJwU6mpXuEN5GJZNkX3XK/. -**TODO:** -- list of modules used -- orbit-db-pubsub -- crdts - ## Contributing We would be happy to accept PRs! If you want to work on something, it'd be good to talk beforehand to make sure nobody else is working on it. You can reach us on IRC [#orbitdb](http://webchat.freenode.net/?channels=%23orbitdb) on Freenode, or in the comments of the [issues section](https://github.com/orbitdb/orbit-db/issues).