diff --git a/.npmignore b/.npmignore index 1cb7b36..74205cb 100644 --- a/.npmignore +++ b/.npmignore @@ -5,7 +5,7 @@ orbitdb/ node_modules/ # Don't distribute examples with the module -# See examples at https://github.com/orbitdb/orbit-db +# See examples at https://github.com/orbitdb/orbit-db examples/ # Don't distribute source maps @@ -15,5 +15,5 @@ dist/*.map dist/orbitdb.js # Don't distribute screenshot -# See examples at https://github.com/orbitdb/orbit-db -screenshots/ +# See examples at https://github.com/orbitdb/orbit-db +images/ diff --git a/README.md b/README.md index 8d5c2e5..8efd68f 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,13 @@ # OrbitDB -[![Gitter](https://img.shields.io/gitter/room/nwjs/nw.js.svg)](https://gitter.im/orbitdb/Lobby) -[![](https://img.shields.io/badge/freenode-%23orbitdb-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23orbitdb) -[![CircleCI Status](https://circleci.com/gh/orbitdb/orbit-db.svg?style=shield)](https://circleci.com/gh/orbitdb/orbit-db) -[![npm version](https://badge.fury.io/js/orbit-db.svg)](https://www.npmjs.com/package/orbit-db) -[![node](https://img.shields.io/node/v/orbit-db.svg)](https://www.npmjs.com/package/orbit-db) -[![Project Status](https://badge.waffle.io/orbitdb/orbit-db.svg?columns=In%20Progress&title=In%20Progress)](https://waffle.io/orbitdb/orbit-db) +

+ +

-> A peer-to-peer database for the decentralized web +[![Gitter](https://img.shields.io/gitter/room/nwjs/nw.js.svg)](https://gitter.im/orbitdb/Lobby) [![](https://img.shields.io/badge/freenode-%23orbitdb-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23orbitdb) [![CircleCI Status](https://circleci.com/gh/orbitdb/orbit-db.svg?style=shield)](https://circleci.com/gh/orbitdb/orbit-db) [![npm version](https://badge.fury.io/js/orbit-db.svg)](https://www.npmjs.com/package/orbit-db) [![node](https://img.shields.io/node/v/orbit-db.svg)](https://www.npmjs.com/package/orbit-db) [![Project Status](https://badge.waffle.io/orbitdb/orbit-db.svg?columns=In%20Progress&title=In%20Progress)](https://waffle.io/orbitdb/orbit-db) -OrbitDB is a serverless, distributed, peer-to-peer database. OrbitDB uses [IPFS](https://ipfs.io) as its data storage and [IPFS Pubsub](https://github.com/ipfs/go-ipfs/blob/master/core/commands/pubsub.go#L23) to automatically sync databases with peers. It's an eventually consistent database that uses [CRDTs](https://en.wikipedia.org/wiki/Conflict-free_replicated_data_type) for conflict-free database merges making OrbitDB an excellent choice for decentralized apps (dApps), blockchain applications and offline-first web applications. + +OrbitDB is a **serverless, distributed, peer-to-peer database**. OrbitDB uses [IPFS](https://ipfs.io) as its data storage and [IPFS Pubsub](https://github.com/ipfs/go-ipfs/blob/master/core/commands/pubsub.go#L23) to automatically sync databases with peers. It's an eventually consistent database that uses [CRDTs](https://en.wikipedia.org/wiki/Conflict-free_replicated_data_type) for conflict-free database merges making OrbitDB an excellent choice for decentralized apps (dApps), blockchain applications and offline-first web applications. **Test it live at [Live demo 1](https://ipfs.io/ipfs/QmeESXh9wPib8Xz7hdRzHuYLDuEUgkYTSuujZ2phQfvznQ/), [Live demo 2](https://ipfs.io/ipfs/QmasHFRj6unJ3nSmtPn97tWDaQWEZw3W9Eh3gUgZktuZDZ/), or [P2P TodoMVC app](https://ipfs.io/ipfs/QmTJGHccriUtq3qf3bvAQUcDUHnBbHNJG2x2FYwYUecN43/)**! @@ -35,7 +33,7 @@ This is the Javascript implementation and it works both in **Browsers** and **No To use with older versions of Node.js, we provide an ES5-compatible build through the npm package, located in `dist/es5/` when installed through npm. #### Community Calls -We also have **regular community calls**, which we announce in the issues in [the @orbitdb welcome repository](https://github.com/orbitdb/welcome/issues). Join us! +We also have regular community calls, which we announce in the issues in [the @orbitdb welcome repository](https://github.com/orbitdb/welcome/issues). Join us! ## Table of Contents @@ -188,7 +186,7 @@ npm run examples:browser-linux ```

- +

Check the code in [examples/browser/browser.html](https://github.com/orbitdb/orbit-db/blob/master/examples/browser/browser.html) and try the [live example](https://ipfs.io/ipfs/QmRosp97r8GGUEdj5Wvivrn5nBkuyajhRXFUcWCp5Zubbo/). @@ -199,7 +197,7 @@ Check the code in [examples/browser/browser.html](https://github.com/orbitdb/orb npm run examples:node ``` - + **Eventlog** diff --git a/screenshots/example1.png b/images/example1.png similarity index 100% rename from screenshots/example1.png rename to images/example1.png diff --git a/screenshots/orbit-db-demo1.gif b/images/orbit-db-demo1.gif similarity index 100% rename from screenshots/orbit-db-demo1.gif rename to images/orbit-db-demo1.gif diff --git a/screenshots/orbit-db-demo3.gif b/images/orbit-db-demo3.gif similarity index 100% rename from screenshots/orbit-db-demo3.gif rename to images/orbit-db-demo3.gif diff --git a/images/orbit_db_logo_color.jpg b/images/orbit_db_logo_color.jpg new file mode 100644 index 0000000..1bf3de2 Binary files /dev/null and b/images/orbit_db_logo_color.jpg differ diff --git a/images/orbit_db_logo_color.png b/images/orbit_db_logo_color.png new file mode 100644 index 0000000..b6eed5c Binary files /dev/null and b/images/orbit_db_logo_color.png differ