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.

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

Updating Readme #6

Merged
merged 1 commit into from
Nov 21, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
"description": "",
"scripts": {
"build": "turbo build",
"dev": "turbo dev",
"lint": "turbo lint",
"ci": "turbo build lint test",
"test": "turbo run test",
Expand Down
23 changes: 7 additions & 16 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Search Params

Read and update [URLSearchParams](https://developer.mozilla.org/en-US/docs/Web/API/URLSearchParams) with full type-safety.
Read and update [URLSearchParams](https://developer.mozilla.org/en-US/docs/Web/API/URLSearchParams) with full type-safety. This repository includes the following packages:

- `@search-params/react`

## Documentation

Expand All @@ -12,27 +14,16 @@ Please visit our [Documentation](https://search-params-docs.vercel.app) for more

The Search Params repository uses [PNPM Workspaces](https://pnpm.io/workspaces) and [Turborepo](https://github.com/vercel/turborepo). To install dependencies, run `pnpm install` in the project root directory.

### Build `@search-params/react`

```bash
cd packages/react
pnpm build
```

### Development

You can also test/debug our packages with the documentation site locally.
You can also test/debug `@search-params/react` with the docs locally. Any change to the docs will re-render instantly. If you update the package, a rebuild is required but using Turborepo this has been set to watch mode.

```bash
cd docs
pnpm dev
```

Any change to docs will rew-render instantly.

If you update any package, a rebuild is required. Or you can use the watch mode for both in separate terminals.
### Build

```bash
cd packages/react
pnpm dev
```
pnpm build
```
1 change: 1 addition & 0 deletions turbo.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
],
"cache": false
},
"dev": {},
"lint": {},
"test": {},
"test:watch": {
Expand Down
Loading