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.

Sign up for GitHub

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

chore: publish swr-devtools-panel #35

Merged
merged 1 commit into from
Oct 14, 2021
Merged

chore: publish swr-devtools-panel #35

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 11 additions & 4 deletions packages/swr-devtools-panel/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,22 @@
# swr-devtools-panel

**This is a private package.**
[![npm version](https://badge.fury.io/js/swr-devtools-panel.svg)](https://badge.fury.io/js/swr-devtools-panel)

This package is a React component of SWR Devtools panel.
This package is a React component of SWR Devtools panel. If you want to use this component as a React component, you can place it on your own.

**This package hasn't been stable yet, so its interface would be changed in the future releases.**
## Install

If you want to use this component as a React component and place it on your own, you should install `styled-components` as well as `react` and `swr`. But this is not a recommend way, and `swr-devtools-panel` hasn't been published yet.
```
// install peerDependencies
$ yarn add react swr styled-components
$ yarn add swr-devtools-panel
```

## How to use

```jsx
import { useSWRConfig } from "swr";
// This package hasn't been published yet.
import { SWRDevToolsPanel } from "swr-devtools-panel";

const App = () => {
Expand Down
1 change: 0 additions & 1 deletion packages/swr-devtools-panel/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
{
"name": "swr-devtools-panel",
"version": "0.2.2",
"private": true,
"description": "A React component for the SWR DevTools panel",
"main": "lib/index.js",
"license": "MIT",
Expand Down
6 changes: 4 additions & 2 deletions packages/swr-devtools/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
# swr-devtools

![A screenshot of SWR Devtools (light theme)](../../imgs/light.png)
[![npm version](https://badge.fury.io/js/swr-devtools.svg)](https://badge.fury.io/js/swr-devtools)

![A screenshot of SWR Devtools (dark theme)](../../imgs/dark.png)
![A screenshot of SWR Devtools (light theme)](https://raw.githubusercontent.com/koba04/swr-devtools/main/imgs/light.png)

![A screenshot of SWR Devtools (dark theme)](https://raw.githubusercontent.com/koba04/swr-devtools/main/imgs/dark.png)

### Install

Expand Down