Skip to content

Commit

Permalink
Merge pull request #1 from orbitdb/docs/update
Browse files Browse the repository at this point in the history
docs: call createOrbitDB correctly.
  • Loading branch information
julienmalard authored Mar 1, 2024
2 parents 2d92e7e + fc7e703 commit d1a4782
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# @orbitdb/ordered-keyvalue-db
Ordered keyvalue database type for orbit-db.
Ordered keyvalue database type for OrbitDB.

[![Tests](https://github.com/orbitdb/ordered-keyvalue-db/actions/workflows/run-test.yml/badge.svg?branch=main)](https://github.com/orbitdb/ordered-keyvalue-db/actions/workflows/tests.yml)
[![codecov](https://codecov.io/gh/orbitdb/ordered-keyvalue-db/graph/badge.svg?token=7OZK4BJDej)](https://codecov.io/gh/orbitdb/ordered-keyvalue-db)
Expand All @@ -14,13 +14,13 @@ A `KeyValue` database where you can move entries around. Ideal for situations wh
## Examples

```ts
import { createOrbit } from "@orbitdb/core";
import { createOrbitDB } from "@orbitdb/core";
import { registerOrderedKeyValue } from "@orbitdb/ordered-keyvalue-db";

// Register database type. IMPORTANT - must call before creating orbit instance !
registerOrderedKeyValue();

const orbit = await createOrbit({ ipfs })
const orbit = await createOrbitDB({ ipfs })

const db = await orbit.open({ type: "ordered-keyvalue" });

Expand Down

0 comments on commit d1a4782

Please sign in to comment.