@uniformdev/search 0.0.3 → 0.0.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +12 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -4,6 +4,18 @@ A lightweight client for [Uniform Search](https://uniform.dev) with optional Rea
|
|
|
4
4
|
|
|
5
5
|
The core client is framework-agnostic. The React bindings are exposed from a separate `@uniformdev/search/react` entry point and `react` is an optional peer dependency, so you only pull in React if you use them.
|
|
6
6
|
|
|
7
|
+
## Getting started with the full UI
|
|
8
|
+
|
|
9
|
+
Want the complete faceted-search experience (search box, results, facets, sorting, pagination) plus the matching Uniform component definitions scaffolded into an existing **Next.js App Router** + Uniform project? Run the initializer from your project root:
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
npm create uniform-search@latest
|
|
13
|
+
# or: npx create-uniform-search
|
|
14
|
+
# or: pnpm create uniform-search
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
It copies the search components + helpers, drops in the Uniform CLI package file, can deploy the Uniform component definitions for you (`sync push` in additive create mode), and optionally installs the companion Claude Code skill. See [`create-uniform-search`](https://www.npmjs.com/package/create-uniform-search) for options. The rest of this README covers using the client library directly.
|
|
18
|
+
|
|
7
19
|
## Installation
|
|
8
20
|
|
|
9
21
|
```bash
|