Skip to content

Commit

Permalink
Merge pull request #7 from orbitdb/chore/upgrade
Browse files Browse the repository at this point in the history
chore: Rebrand liftoff. Update OrbitDB.
  • Loading branch information
haydenyoung authored Oct 30, 2024
2 parents 1557ffe + 261bf61 commit d3f7b63
Show file tree
Hide file tree
Showing 10 changed files with 2,639 additions and 4,304 deletions.
2 changes: 1 addition & 1 deletion .npmignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ node_modules/
dist/*.map

# Don't distribute the debug build
dist/orbitdb-quickstart.js
dist/orbitdb-liftoff.js

.git
test
Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Please contribute! Here are some things that would be great:

- [Open an issue!](https://github.com/orbitdb/quickstart/issues/new)
- [Open an issue!](https://github.com/orbitdb/liftoff/issues/new)
- Open a pull request!
- Say hi! :wave:

Expand Down
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# OrbitDB Quickstart
# OrbitDB Liftoff

[![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)
[![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/liftoff)](https://www.npmjs.com/package/@orbitdb/liftoff) [![node-current (scoped)](https://img.shields.io/node/v/%40orbitdb/liftoff)](https://www.npmjs.com/package/@orbitdb/liftoff)

A preconfigured OrbitDB instance which allows users to quickly "test drive" OrbitDB.

Expand All @@ -11,15 +11,15 @@ This repository provides convenience functions and IPFS and Libp2p configuration
This project uses [npm](http://npmjs.com/) and [nodejs](https://nodejs.org/).

```sh
npm i @orbitdb/quickstart
npm i @orbitdb/liftoff
```

## Usage

To launch a OrbitDB instance and open a database, run `startOrbitDB`:

```js
import { startOrbitDB, stopOrbitDB } from '@orbitdb/quickstart'
import { startOrbitDB, stopOrbitDB } from '@orbitdb/liftoff'

const orbitdb = await startOrbitDB()
const db1 = await orbitdb.open('db1')
Expand All @@ -28,11 +28,11 @@ console.log(await db1.all())
await stopOrbitDB(orbitdb)
```

OrbitDB Quickstart also includes default Libp2p configurations for Node.js and browser for basic connections between multiple peers:
OrbitDB Liftoff also includes default Libp2p configurations for Node.js and browser for basic connections between multiple peers:

```js
import { createOrbitDB } from '@orbitdb/core'
import { DefaultLibp2pOptions } from '@orbitdb/quickstart'
import { DefaultLibp2pOptions } from '@orbitdb/liftoff'

const libp2p = createLibp2p({ ...DefaultLibp2pOptions })
const ipfs = await createHelia({ libp2p })
Expand Down
2 changes: 1 addition & 1 deletion conf/webpack.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ export default (env, argv) => {
mode: 'production',
entry: './src/index.js',
output: {
filename: '../dist/orbitdb-quickstart.min.js',
filename: '../dist/orbitdb-liftoff.min.js',
library: {
name: 'OrbitDB',
type: 'var'
Expand Down
2 changes: 1 addition & 1 deletion conf/webpack.debug.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ export default (env, argv) => {
mode: 'development',
entry: './src/index.js',
output: {
filename: '../dist/orbitdb-quickstart.js',
filename: '../dist/orbitdb-liftoff.js',
library: {
name: 'OrbitDB',
type: 'var'
Expand Down
Loading

0 comments on commit d3f7b63

Please sign in to comment.