Skip to content

Commit e20bb8b

Browse files
authored
docs: update docs (#29)
* docs: update docs * chore: add new release scripts
1 parent d9b9186 commit e20bb8b

File tree

2 files changed

+18
-18
lines changed

2 files changed

+18
-18
lines changed

README.md

Lines changed: 15 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,6 @@
55
- Jotai version `>=1.11.0`
66
- React version `>=17.0.0`
77

8-
### V1 to V2 Jotai migration guide
9-
10-
_Please note that this version does *NOT* work with the V1 API of Jotai_.
11-
12-
Find the official migration guide on
13-
[jotai.org](https://jotai.org/docs/guides/migrating-to-v2-api)
14-
15-
### V1 to V2 `jotai-devtools` migration guide
16-
17-
Find documentation for V1 `jotai-devtools`
18-
[here](https://github.com/jotai-labs/jotai-devtools/tree/v0.1.0)
19-
208
## Setup
219

2210
```sh
@@ -27,9 +15,9 @@ npm install jotai-devtools --save
2715
yarn add jotai-devtools
2816
```
2917

30-
### APIs
18+
## API
3119

32-
Detailed documentation -
20+
Detailed documentation is available on
3321
[https://jotai.org/docs/api/devtools](https://jotai.org/docs/api/devtools)
3422

3523
```tsx
@@ -43,7 +31,14 @@ import {
4331
} from 'jotai-devtools';
4432
```
4533

46-
### Migration guide from `jotai/react/devtools` to `jotai-devtools`
34+
## Migration guides
35+
36+
### Migrate Jotai to V2
37+
38+
Find the official migration guide on
39+
[jotai.org](https://jotai.org/docs/guides/migrating-to-v2-api)
40+
41+
### Migrate `jotai/react/devtools` to `jotai-devtools`
4742

4843
1. Install this package
4944

@@ -67,5 +62,8 @@ import {
6762
- } from 'jotai/react/devtools';
6863
+ } from 'jotai-devtools';
6964
```
70-
✨ UI based devtools is
71-
[coming soon](https://twitter.com/dai_shi/status/1611717249471246338])!
65+
66+
### Other announcements
67+
68+
✨ UI based devtools is
69+
[coming soon](https://twitter.com/dai_shi/status/1611717249471246338)!

package.json

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,9 @@
5353
"postcompile": "node -e \"require('shelljs').find('dist/**/*.d.ts').forEach(f=>require('fs').copyFileSync(f,f.replace(/\\.ts$/,'.mts')))\";",
5454
"prerelease": "yarn install --immutable && yarn run lint && yarn run test && yarn run compile",
5555
"release": "release-it",
56-
"release:next": "yarn run release --preRelease=next"
56+
"release:next": "yarn run release --preRelease=next",
57+
"release:minor": "yarn run release minor",
58+
"release:patch": "yarn run release patch"
5759
},
5860
"repository": {
5961
"type": "git",

0 commit comments

Comments
 (0)