From 618d8251e2d60eebf186f261d5f8a67ac4a465d0 Mon Sep 17 00:00:00 2001 From: savvasmoke <136869149+savvar9991@users.noreply.github.com> Date: Sun, 15 Dec 2024 21:21:38 +1100 Subject: [PATCH 1/2] Update README.md --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 4eaf456..550b82f 100644 --- a/README.md +++ b/README.md @@ -48,7 +48,7 @@ pnpm add @lens-protocol/metadata zod ``` > [!NOTE] -> `zod` is marked as optional peer dependency, so if you all you need is the JSON Schema definitions, you can install `@lens-protocol/metadata` without `zod`. +> `zod` is marked as optional peer dependency, so if all you need is the JSON Schema definitions, you can install `@lens-protocol/metadata` without `zod`. ## Documentation @@ -130,7 +130,7 @@ const invalid = { #### Post metadata -Post metadata schema is a union of all _content_ schemas (e.g. `ArticleMetadata`, `AudioMetadata`, etc. +Post metadata schema is a union of all _content_ schemas (e.g. `ArticleMetadata`, `AudioMetadata`, etc.). Use it to parse the metadata referenced by `contentURI` of Lens Post. @@ -476,7 +476,7 @@ import { ``` > [!NOTE] -> If you find yourself in a position of importing from both `@lens-protocol/metadata` and `@lens-protocol/metadata/legacy` entrypoints in the same module. You can you can use ESModule aliasing to avoid conflicts: `import * as legacy from '@lens-protocol/metadata/legacy'` and then use the legacy types, enums, and parsers under `legacy.*`. +> If you find yourself in a position of importing from both `@lens-protocol/metadata` and `@lens-protocol/metadata/legacy` entrypoints in the same module. You can use ESModule aliasing to avoid conflicts: `import * as legacy from '@lens-protocol/metadata/legacy'` and then use the legacy types, enums, and parsers under `legacy.*`. ## JSON schemas From 4d2f83fe51c757a64a038b561005fb55924eec9d Mon Sep 17 00:00:00 2001 From: savvasmoke <136869149+savvar9991@users.noreply.github.com> Date: Sun, 15 Dec 2024 21:34:58 +1100 Subject: [PATCH 2/2] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 550b82f..9c7cb20 100644 --- a/README.md +++ b/README.md @@ -198,7 +198,7 @@ if (!result.success) { ### Narrowing types -Every time you have a discriminated union, you can use the discriminant to narrow the type. See few examples below. +Every time you have a discriminated union, you can use the discriminant to narrow the type. See a few examples below. #### `PostMetadata`