Skip to content

Commit 4b86acd

Browse files
committed
Rename Svelte registry to @ndk/svelte
1 parent 8054a92 commit 4b86acd

5 files changed

Lines changed: 27 additions & 31 deletions

File tree

svelte/registry/README.md

Lines changed: 10 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# @nostr/svelte Component Registry
1+
# @ndk/svelte Component Registry
22

33
A comprehensive collection of beautiful, production-ready Svelte 5 components for building Nostr applications. Built on NDK and distributed through jsrepo.
44

5-
## What is @nostr/svelte?
5+
## What is @ndk/svelte?
66

7-
The @nostr/svelte registry provides a curated set of UI components, hooks, utilities, and complete blocks specifically designed for Nostr applications. All components are:
7+
The `@ndk/svelte` registry provides a curated set of UI components, builders, utilities, and complete blocks specifically designed for Nostr applications. All components are:
88

99
- **Svelte 5 Native** - Built from the ground up using Svelte 5 runes
1010
- **NDK Powered** - Deep integration with [@nostr-dev-kit/svelte](https://github.com/nostr-dev-kit/ndk)
@@ -17,19 +17,13 @@ The @nostr/svelte registry provides a curated set of UI components, hooks, utili
1717
The registry includes a comprehensive collection of components organized into categories:
1818

1919
- **🧱 Blocks** - Complete, ready-to-use UI sections like login interfaces and thread viewers
20+
- **🛠️ Builders** - Reusable stateful primitives for composing Nostr interactions
2021
- **🎨 Components** - Individual UI components for users, articles, events, hashtags, highlights, media, and more
2122
- **🎯 UI Primitives** - Low-level, composable building blocks for custom layouts
22-
- **🪝 Hooks** - Reactive hooks for common Nostr patterns
2323
- **🛠️ Utilities** - Helper functions for formatting, parsing, and data manipulation
2424
- **🎭 Icons** - Optimized Svelte icon components
2525

26-
To see all available components, run:
27-
28-
```bash
29-
jsrepo info @nostr/svelte
30-
```
31-
32-
Or browse the [component showcase](#) to see live examples and documentation for each component.
26+
Browse the published registry at [jsrepo.com/@ndk/svelte](https://www.jsrepo.com/@ndk/svelte), or run the local showcase app to explore `/components` and `/docs/components`.
3327

3428
## Quick Start
3529

@@ -52,7 +46,7 @@ bun add -g jsrepo
5246
2. **Initialize jsrepo in your project**
5347

5448
```bash
55-
jsrepo init @nostr/svelte
49+
jsrepo init @ndk/svelte@latest
5650
```
5751

5852
This creates a `jsrepo.config.ts` configuration file in your project.
@@ -93,18 +87,13 @@ jsrepo add components/user-card ui/user
9387
For comprehensive installation instructions, configuration options, and component documentation, visit:
9488

9589
- **Installation Guide**: `/docs/installation` (in the showcase app)
96-
- **Component Examples**: Browse the showcase at [your-deployed-url]
90+
- **Registry Page**: [jsrepo.com/@ndk/svelte](https://www.jsrepo.com/@ndk/svelte)
91+
- **Component Examples**: Browse `/components` and `/docs/components` in the showcase app
9792
- **NDK Documentation**: [NDK Svelte Guide](https://github.com/nostr-dev-kit/ndk)
9893

9994
## jsrepo Registry
10095

101-
This registry is published to [jsrepo.com](https://jsrepo.com) as `@nostr/svelte`.
102-
103-
To explore all available components:
104-
105-
```bash
106-
jsrepo info @nostr/svelte
107-
```
96+
This registry is published to [jsrepo.com/@ndk/svelte](https://www.jsrepo.com/@ndk/svelte) as `@ndk/svelte`.
10897

10998
## Development
11099

@@ -121,10 +110,9 @@ registry/
121110
│ │ │ ├── ui/ # UI primitives
122111
│ │ │ ├── blocks/ # Complete UI blocks
123112
│ │ │ ├── builders/ # Component builders
124-
│ │ │ ├── hooks/ # Svelte hooks
125113
│ │ │ ├── utils/ # Utility functions
126114
│ │ │ └── icons/ # Icon components
127-
│ │ └── site-components/ # Showcase components
115+
│ │ └── site/ # Showcase app code
128116
│ └── routes/ # Showcase pages
129117
├── jsrepo.config.ts # jsrepo configuration (project + registry)
130118
└── registry.json # Generated manifest

svelte/registry/jsrepo.config.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -179,7 +179,7 @@ export default defineConfig({
179179

180180
// Registry configuration (for building THIS registry)
181181
registry: ({ cwd }) => ({
182-
name: "@nostr/svelte",
182+
name: "@ndk/svelte",
183183
version: REGISTRY_VERSION,
184184
excludeDeps: ["svelte"],
185185
defaultPaths: {

svelte/registry/registry.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

svelte/registry/src/routes/(app)/docs/installation/+page.svelte

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@
1313
import layoutInit from './examples/layout-init.svelte.example?raw';
1414
import jsrepoInit from './examples/jsrepo-init.example?raw';
1515
import jsrepoConfig from './examples/jsrepo-config.example?raw';
16-
import jsrepoInfo from './examples/jsrepo-info.example?raw';
1716
import jsrepoAdd from './examples/jsrepo-add.example?raw';
1817
import usingComponents from './examples/using-components.svelte.example?raw';
1918
import jsrepoUpdate from './examples/jsrepo-update.example?raw';
@@ -23,7 +22,7 @@
2322

2423
<PageTitle
2524
title="Installation"
26-
subtitle="Complete guide to installing and configuring the @nostr-dev-kit/svelte component registry in your SvelteKit project."
25+
subtitle="Complete guide to installing and configuring the @ndk/svelte component registry in your SvelteKit project."
2726
/>
2827

2928
<div class="docs-page">
@@ -110,7 +109,7 @@ cp node_modules/@nostr-dev-kit/cache-sqlite-wasm/dist/worker.js static/"
110109
<h2>Step 3: Install jsrepo CLI</h2>
111110

112111
<p>
113-
jsrepo is the package manager for @nostr-dev-kit/svelte components. Install it globally to use across
112+
jsrepo installs components from the <code>@ndk/svelte</code> registry. Install it globally to use across
114113
projects:
115114
</p>
116115

@@ -152,7 +151,12 @@ cp node_modules/@nostr-dev-kit/cache-sqlite-wasm/dist/worker.js static/"
152151

153152
<h3>Browse Available Components</h3>
154153

155-
<CodeBlock lang="bash" code={jsrepoInfo} />
154+
<p>
155+
Browse the published registry at <a href="https://www.jsrepo.com/@ndk/svelte">jsrepo.com/@ndk/svelte</a>
156+
or explore this site's <a href="/components">component gallery</a> and
157+
<a href="/docs/components">component docs</a>, then install the items you want with
158+
<code>jsrepo add</code>.
159+
</p>
156160

157161
<h3>Add Components</h3>
158162

@@ -347,7 +351,7 @@ cp node_modules/@nostr-dev-kit/cache-sqlite-wasm/dist/worker.js static/"
347351
<h2>Step 5: Install jsrepo CLI</h2>
348352

349353
<p>
350-
jsrepo is the package manager for @nostr-dev-kit/svelte components. Install it globally to use across
354+
jsrepo installs components from the <code>@ndk/svelte</code> registry. Install it globally to use across
351355
projects:
352356
</p>
353357

@@ -387,7 +391,12 @@ cp node_modules/@nostr-dev-kit/cache-sqlite-wasm/dist/worker.js static/"
387391

388392
<h3>Browse Available Components</h3>
389393

390-
<CodeBlock lang="bash" code={jsrepoInfo} />
394+
<p>
395+
Browse the published registry at <a href="https://www.jsrepo.com/@ndk/svelte">jsrepo.com/@ndk/svelte</a>
396+
or explore this site's <a href="/components">component gallery</a> and
397+
<a href="/docs/components">component docs</a>, then install the items you want with
398+
<code>jsrepo add</code>.
399+
</p>
391400

392401
<h3>Add Components</h3>
393402

svelte/registry/src/routes/(app)/docs/installation/examples/jsrepo-info.example

Lines changed: 0 additions & 1 deletion
This file was deleted.

0 commit comments

Comments
 (0)