Skip to content

Commit

Permalink
docs: improve nest pkg readme
Browse files Browse the repository at this point in the history
  • Loading branch information
icidasset committed Dec 15, 2023
1 parent 345da63 commit 863c501
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions packages/nest/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ import { FileSystem, Path } from '@wnfs-wg/nest'
import { MemoryBlockstore } from 'blockstore-core/memory'
```

Scenario 1:
Scenario 1:<br />
🚀 Create a new file system, create a new file and read it back.

```ts
Expand All @@ -46,14 +46,14 @@ await fs.write(
const contents = await fs.read(Path.file('private', 'file'), 'utf8')
```

Scenario 2:
Scenario 2:<br />
🛰️ Listen to commit and/or publish events.

_A commit is a (optionally verified) modification to the file system,
_A commit is a (optionally verified) modification to the file system,<br />
and publishes are the debounced events resulting from the commits._

This will allow us the store the latest state of our file system,
for this we need what we call the data root. This is the top-level CID
This will allow us the store the latest state of our file system,<br />
for this we need what we call the data root. This is the top-level CID<br />
of our root tree, the pointer to our file system.

```ts
Expand All @@ -79,7 +79,7 @@ fs.on('publish', ({ dataRoot }) => {
})
```

Scenario 3:
Scenario 3:<br />
🧳 Load a file system from a previous pointer.

```ts
Expand Down

0 comments on commit 863c501

Please sign in to comment.