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

Jump to bottom

Update quickstart.md: Clearly differentiate between examples that should be copied and those that should not #70

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update quickstart.md: Clearly differentiate between examples that should be copied and those that should not #70

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
9 changes: 4 additions & 5 deletions docs/quickstart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -198,14 +198,13 @@ First, we'll add a network adapter to the `Repo` in our web app which syncs to a
yarn add @automerge/automerge-repo-network-websocket
```

Then add a network adapter connecting the repo to `sync.automerge.org`
Then we'll add a network adapter connecting the repo to `sync.automerge.org`. Add the following import and change the repo definition in `main.tsx`:

```
```js
// main.tsx
// Add this import
import { BrowserWebSocketClientAdapter } from "@automerge/automerge-repo-network-websocket"

...

// now update the repo definition to look like this:
const repo = new Repo({
Expand Down Expand Up @@ -257,13 +256,13 @@ This change will be reflected in any connected and listening handles. Go back to

## Saving the document

If you provide a `Repo` with a `StorageAdapter` then it will save documents for use later. In the browser we used IndexedDB:
If you provide a `Repo` with a `StorageAdapter` then it will save documents for use later. In the example so far we use `IndexedDB`, as you can see in the `storage` option to `Repo`:

```js
import { IndexedDBStorageAdapter } from '@automerge/automerge-repo-storage-indexeddb'
import { BrowserWebSocketClientAdapter } from '@automerge/automerge-repo-network-websocket'

const repo = new AutomergeRepo.Repo({
const repo = new Repo({
network: [new BrowserWebSocketClientAdapter('wss://sync.automerge.org')],
storage: new IndexedDBStorageAdapter(),
})
Expand Down