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

John/readme #79

Merged
merged 13 commits into from
Jul 8, 2024
Binary file removed .DS_Store
Binary file not shown.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,7 @@ public/

# macOS
*.DS_Store
.DS_Store
*.AppleDouble
*.LSOverride

Expand Down
7 changes: 7 additions & 0 deletions License.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Released under MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
27 changes: 24 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,18 +35,37 @@ React Query Rewind introduces a powerful DevTool extension designed to work in c

1. Download npm package into your application.

**React**

```sh
npm i -D react-query-rewind
```

2. Import the ReactQueryRewind component into the root of your applicaiton.
**Svelte**

```sh
npm i --save-dev @react-query-rewind/svelte-query-rewind
```

**Vue**

```sh
npm i --save-dev @react-query-rewind/vue-query-rewind
```

_picture of importing the component_
2. Import the ReactQueryRewind component into the root of your applicaiton.

```javascript
import ReactQueryRewind from "react-query-rewind";
```

_Note: Some older versions of NextJS default to the commonJS version of the package, causing apps to error_
_If you encounter this error, import the component with:_

```javascript
import ReactQueryRewind from "../../node_modules/react-query-rewind/dist/esm/index.js";
```

3. Place ReactQueryRewind next to the root of your application inside the QueryClientProvider component.

```javascript
Expand Down Expand Up @@ -108,7 +127,9 @@ Rui Fan - [GitHub](https://github.com/ruifan-IU) - [LinkedIn](https://www.linked
[![Medium](https://img.shields.io/badge/Medium-12100E?style=for-the-badge&logo=medium&logoColor=white)](https://medium.com/@teeringe/react-query-rewind-time-travel-debugging-made-simple-46aaeeafd497)
[![LinkedIn](https://img.shields.io/badge/LinkedIn-0077B5?style=for-the-badge&logo=linkedin&logoColor=white)](https://www.linkedin.com/company/react-query-rewind/)

Project Link: [React Query Rewind](https://github.com/oslabs-beta/react-query-rewind-chrome)
Project Link: [React Query Rewind](https://github.com/oslabs-beta/react-query-rewind)

Website: [reactqueryrewind.com](https://reactqueryrewind.com/)

# License
[MIT](https://www.mit.edu/~amini/LICENSE.md)
Expand Down
13 changes: 10 additions & 3 deletions package-react/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,12 +41,17 @@ React Query Rewind introduces a powerful DevTool extension designed to work in c

2. Import the ReactQueryRewind component into the root of your applicaiton.

_picture of importing the component_

```javascript
import ReactQueryRewind from "react-query-rewind";
```

_Note: Some older versions of NextJS default to the commonJS version of the package, causing apps to error_
_If you encounter this error, import the component with:_

```javascript
import ReactQueryRewind from "../../node_modules/react-query-rewind/dist/esm/index.js";
```

3. Place ReactQueryRewind next to the root of your application inside the QueryClientProvider component.

```javascript
Expand Down Expand Up @@ -108,7 +113,9 @@ Rui Fan - [GitHub](https://github.com/ruifan-IU) - [LinkedIn](https://www.linked
[![Medium](https://img.shields.io/badge/Medium-12100E?style=for-the-badge&logo=medium&logoColor=white)](https://medium.com/@teeringe/react-query-rewind-time-travel-debugging-made-simple-46aaeeafd497)
[![LinkedIn](https://img.shields.io/badge/LinkedIn-0077B5?style=for-the-badge&logo=linkedin&logoColor=white)](https://www.linkedin.com/company/react-query-rewind/)

Project Link: [React Query Rewind](https://github.com/oslabs-beta/react-query-rewind-chrome)
Project Link: [React Query Rewind](https://github.com/oslabs-beta/react-query-rewind)

Website: [reactqueryrewind.com](https://reactqueryrewind.com/)

# License
[MIT](https://www.mit.edu/~amini/LICENSE.md)
Expand Down
2 changes: 1 addition & 1 deletion package-react/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
"type": "git",
"url": "git+https://github.com/oslabs-beta/react-query-rewind.git"
},
"version": "2.1.9",
"version": "2.1.11",
"description": "React Query Rewind is a library that helps developers debug applications that use React Query (ie TanStack Query) by letting them time travel through state changes directly in their chrome dev tools",
"keywords": [
"react",
Expand Down
10 changes: 5 additions & 5 deletions package-svelte/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,15 +36,13 @@ Svelte Query Rewind introduces a powerful DevTool extension designed to work in
1. Download npm package into your application as a dev dependency.

```sh
npm i --save-dev react-query-rewind
npm i --save-dev @react-query-rewind/svelte-query-rewind
```

2. Import the ReactQueryRewind component into the root of your applicaiton.

_picture of importing the component_

```javascript
import ReactQueryRewind from 'react-query-rewind';
import ReactQueryRewind from '@react-query-rewind/svelte-query-rewind;`
```

3. Place ReactQueryRewind next to the root of your application inside the QueryClientProvider component.
Expand Down Expand Up @@ -97,7 +95,9 @@ Rui Fan - [GitHub](https://github.com/ruifan-IU) - [LinkedIn](https://www.linked
[![Medium](https://img.shields.io/badge/Medium-12100E?style=for-the-badge&logo=medium&logoColor=white)](https://medium.com/@teeringe/react-query-rewind-time-travel-debugging-made-simple-46aaeeafd497)
[![LinkedIn](https://img.shields.io/badge/LinkedIn-0077B5?style=for-the-badge&logo=linkedin&logoColor=white)](https://www.linkedin.com/company/react-query-rewind/)

Project Link: [React Query Rewind](https://github.com/oslabs-beta/react-query-rewind-chrome)
Project Link: [React Query Rewind](https://github.com/oslabs-beta/react-query-rewind)

Website: [reactqueryrewind.com](https://reactqueryrewind.com/)

# License

Expand Down
4 changes: 2 additions & 2 deletions package-svelte/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 4 additions & 4 deletions package-svelte/package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "react-query-rewind",
"name": "@react-query-rewind/svelte-query-rewind",
"contributors": [
{
"name": "John Dunn"
Expand All @@ -16,12 +16,12 @@
],
"repository": {
"type": "git",
"url": "git+https://github.com/oslabs-beta/react-query-rewind"
"url": "git+https://github.com/oslabs-beta/react-query-rewind.git"
},
"version": "1.1.6",
"version": "1.1.8",
"description": "Svelte Query Rewind is a library that helps developers debug applications that use React Query (ie TanStack Query) by letting them time travel through state changes directly in their chrome dev tools",
"keywords": [
"react",
"svelte",
"react query",
"tanstack query",
"@tanstack",
Expand Down
20 changes: 8 additions & 12 deletions package-vue/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,26 +36,20 @@ Vue Query Rewind introduces a powerful DevTool extension designed to work in con
1. Download npm package into your application as a dev dependency.

```sh
npm i --save-dev react-query-rewind
npm i --save-dev @react-query-rewind/vue-query-rewind
```

2. Import the ReactQueryRewind component into the root of your applicaiton.

_picture of importing the component_

```javascript
import ReactQueryRewind from 'react-query-rewind';
import VueQueryRewind from '@react-query-rewind/vue-query-rewind';
```

3. Place ReactQueryRewind next to the root of your application inside the QueryClientProvider component.
3. Use the VueQuery plugins

```javascript
ReactDOM.createRoot(document.getElementById('root')!).render(
<QueryClientProvider client={queryClient}>
<App />
<ReactQueryRewind />
</QueryClientProvider>
);
app.use(VueQueryPlugin, { queryClient }); // from Tanstack
app.use(VueQueryRewind);
```

4. Open the Chrome DevTool Extension and start coding!
Expand Down Expand Up @@ -97,7 +91,9 @@ Rui Fan - [GitHub](https://github.com/ruifan-IU) - [LinkedIn](https://www.linked
[![Medium](https://img.shields.io/badge/Medium-12100E?style=for-the-badge&logo=medium&logoColor=white)](https://medium.com/@teeringe/react-query-rewind-time-travel-debugging-made-simple-46aaeeafd497)
[![LinkedIn](https://img.shields.io/badge/LinkedIn-0077B5?style=for-the-badge&logo=linkedin&logoColor=white)](https://www.linkedin.com/company/react-query-rewind/)

Project Link: [React Query Rewind](https://github.com/oslabs-beta/react-query-rewind-chrome)
Project Link: [React Query Rewind](https://github.com/oslabs-beta/react-query-rewind)

Website: [reactqueryrewind.com](https://reactqueryrewind.com/)

# License

Expand Down
5 changes: 3 additions & 2 deletions package-vue/package.json
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
{
"name": "@react-query-rewind/vue-query-rewind",
"version": "1.1.6",
"version": "1.1.9",
"description": "Vue Query Rewind is a library that helps developers debug applications that use React Query (ie TanStack Query) by letting them time travel through state changes directly in their chrome dev tools",
"type": "module",
"files": [
"dist"
],
"repository": {
"type": "git",
"url": "git+https://github.com/oslabs-beta/react-query-rewind"
"url": "git+https://github.com/oslabs-beta/react-query-rewind.git"
},
"main": "./dist/VueQueryRewind.cjs.js",
"module": "./dist/VueQueryRewind.es.js",
Expand Down Expand Up @@ -47,6 +47,7 @@
"vue-plugin",
"tanstack"
],
"license": "MIT",
"contributors": [
{
"name": "John Dunn"
Expand Down