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

Fix grammar, remove duplicates and add missing punctuation #76

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Fix grammar, remove duplicates and add missing punctuation #76

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
618d825
Update README.md
savvar9991 Dec 15, 2024
4d2f83f
Update README.md
savvar9991 Dec 15, 2024
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
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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.

Expand Down Expand Up @@ -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`

Expand Down Expand Up @@ -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

Expand Down