diff --git a/README.md b/README.md index 8f45605..4dc8013 100644 --- a/README.md +++ b/README.md @@ -525,14 +525,16 @@ class TodoComponent { Install the `@ngneat/query-devtools` package. Lazy load and use it only in `development` environment: ```ts -import { provideQueryDevTools } from '@ngneat/query'; +import { provideQueryDevTools } from '@ngneat/query-devtools'; import { environment } from 'src/environments/environment'; bootstrapApplication(AppComponent, { - providers: [environment.production ? [] : provideQueryDevTools()], + providers: [environment.production ? [] : provideQueryDevTools(options)], }); ``` +See all the avilable options [here](https://tanstack.com/query/v5/docs/react/devtools#options). + ## SSR On the Server: diff --git a/devtools/README.md b/devtools/README.md index 4655cda..3b9070e 100644 --- a/devtools/README.md +++ b/devtools/README.md @@ -1,7 +1,19 @@ -# devtools +# ngneat/query-devtools -This library was generated with [Nx](https://nx.dev). +Wave your hands in the air and shout hooray because Angular Query comes with dedicated devtools! 🥳 -## Running unit tests +When you begin your Angular Query journey, you'll want these devtools by your side. They help visualize all of the inner workings of Angular Query and will likely save you hours of debugging if you find yourself in a pinch! + +Install the `@ngneat/query-devtools` package. Lazy load and use it only in `development` environment: + +```ts +import { provideQueryDevTools } from '@ngneat/query'; +import { environment } from 'src/environments/environment'; + +bootstrapApplication(AppComponent, { + providers: [environment.production ? [] : provideQueryDevTools(options)], +}); +``` + +See all the avilable options [here](https://tanstack.com/query/v5/docs/react/devtools#options). -Run `nx test devtools` to execute the unit tests. diff --git a/package.json b/package.json index 8f38fd6..c5fc493 100644 --- a/package.json +++ b/package.json @@ -7,9 +7,10 @@ "build": "nx build query", "build:playground": "nx build query-playground", "build:devtools": "nx build devtools", - "build:all": "nx run-many --target=build", + "build:all": "nx run-many --target=build && npm run copy", "test:all": "nx run-many --target=test", "lint:all": "nx run-many --target=lint", + "copy": "cp README.md dist/query && cp devtools/README.md dist/devtools", "start": "nx serve", "format": "nx format:write --all", "update": "nx migrate latest",