Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: call createOrbitDB correctly. #1

Merged
merged 1 commit into from
Mar 1, 2024
Merged

docs: call createOrbitDB correctly. #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
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
Loading