diff --git a/package.json b/package.json index 8383e75..f2b76e9 100644 --- a/package.json +++ b/package.json @@ -7,6 +7,7 @@ "description": "", "scripts": { "build": "turbo build", + "dev": "turbo dev", "lint": "turbo lint", "ci": "turbo build lint test", "test": "turbo run test", diff --git a/readme.md b/readme.md index 4b10d9e..1f4c287 100644 --- a/readme.md +++ b/readme.md @@ -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 @@ -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 -``` \ No newline at end of file +pnpm build +``` diff --git a/turbo.json b/turbo.json index 0cf7c00..8bf2e3a 100644 --- a/turbo.json +++ b/turbo.json @@ -11,6 +11,7 @@ ], "cache": false }, + "dev": {}, "lint": {}, "test": {}, "test:watch": {