Skip to content

Commit 5fba31d

Browse files
committed
Update readme
1 parent a88726d commit 5fba31d

File tree

1 file changed

+24
-2
lines changed

1 file changed

+24
-2
lines changed

README.md

+24-2
Original file line numberDiff line numberDiff line change
@@ -5,20 +5,42 @@ Reusable Svelte components.
55
## Installation
66

77
```
8+
# With npm
89
npm add @nostr-dev-kit/ndk-svelte-components
10+
11+
# With pnpm
12+
pnpm add @nostr-dev-kit/ndk-svelte-components
13+
14+
# With yarn
15+
yarn install @nostr-dev-kit/ndk-svelte-components
916
```
1017

1118
## Storybook
1219

20+
This project uses `pnpm` to manage dependencies.
21+
1322
```
1423
git clone https://github.com/nostr-dev-kit/ndk-svelte-components
1524
cd ndk-svelte-components
16-
npm i
17-
npm run storybook
25+
pnpm i
26+
pnpm run storybook
1827
```
1928

2029
# Components
2130

31+
## Event
32+
33+
### `<EventCard>`
34+
35+
Displays a card with formatted event content.
36+
37+
### `<EventContent>`
38+
39+
Formats the content of an event for an `EventCard`. Currently supports:
40+
41+
- kind 1 events
42+
- Embedded kind 1 events in other kind 1 events
43+
2244
## User
2345

2446
### `<Avatar>`

0 commit comments

Comments
 (0)