From 863c5018370c049d1bf738a6e168378b4717b137 Mon Sep 17 00:00:00 2001 From: Steven Vandevelde Date: Fri, 15 Dec 2023 15:31:05 +0100 Subject: [PATCH] docs: improve nest pkg readme --- packages/nest/readme.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/packages/nest/readme.md b/packages/nest/readme.md index 9c6ebca..31e2474 100644 --- a/packages/nest/readme.md +++ b/packages/nest/readme.md @@ -31,7 +31,7 @@ import { FileSystem, Path } from '@wnfs-wg/nest' import { MemoryBlockstore } from 'blockstore-core/memory' ``` -Scenario 1: +Scenario 1:
🚀 Create a new file system, create a new file and read it back. ```ts @@ -46,14 +46,14 @@ await fs.write( const contents = await fs.read(Path.file('private', 'file'), 'utf8') ``` -Scenario 2: +Scenario 2:
🛰️ 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,
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,
+for this we need what we call the data root. This is the top-level CID
of our root tree, the pointer to our file system. ```ts @@ -79,7 +79,7 @@ fs.on('publish', ({ dataRoot }) => { }) ``` -Scenario 3: +Scenario 3:
🧳 Load a file system from a previous pointer. ```ts