From abfe6a677d7b91500438c628ef61006c07d6d6bb Mon Sep 17 00:00:00 2001 From: haad Date: Fri, 19 Jan 2024 10:13:09 +0100 Subject: [PATCH] Update README --- README.md | 15 ++++----------- 1 file changed, 4 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 2cf3209..0d282eb 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,9 @@ [![Matrix](https://img.shields.io/matrix/orbit-db%3Amatrix.org)](https://app.element.io/#/room/#orbit-db:matrix.org) [![npm (scoped)](https://img.shields.io/npm/v/%40orbitdb/quickstart)](https://www.npmjs.com/package/@orbitdb/quickstart) [![node-current (scoped)](https://img.shields.io/node/v/%40orbitdb/quickstart)](https://www.npmjs.com/package/@orbitdb/quickstart) -A preconfigured instance which allows developers to "test drive" OrbitDB. +A preconfigured OrbitDB instance which allows users to quickly "test drive" OrbitDB. -This repository provides convenience functions and configurations to deploy OrbitDB quickly and with minimal knowledge of Helia/Libp2p. +This repository provides convenience functions and IPFS and Libp2p configurations to deploy OrbitDB quickly and with minimal knowledge of Helia/Libp2p. ## Install @@ -24,6 +24,7 @@ import { startOrbitDB, stopOrbitDB } from '@orbitdb/quickstart' const orbitdb = await startOrbitDB() const db1 = await orbitdb.open('db1') await db1.add('hello world!') +console.log(await db1.all()) await stopOrbitDB(orbitdb) ``` @@ -40,17 +41,9 @@ const orbitdb = await createOrbitDB({ ipfs }) const db1 = await orbitdb.open('db1') await db1.add('hello world!') +console.log(await db1.all()) ``` -## Contribute - -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 Gitter](https://gitter.im/orbitdb/Lobby), or in the [issues section](https://github.com/orbitdb//issues). - -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! - -If you want to code but don't know where to start, check out the issues labelled ["help wanted"](https://github.com/orbitdb/quickstart/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22+sort%3Areactions-%2B1-desc). - -For specific guidelines for contributing to this repository, check out the [Contributing guide](CONTRIBUTING.md). For more on contributing to OrbitDB in general, take a look at the [@OrbitDB welcome repository](https://github.com/orbitdb/welcome). Please note that all interactions in [@OrbitDB](https://github.com/orbitdb) fall under our [Code of Conduct](CODE_OF_CONDUCT.md). ## License