Skip to content

Commit 9a89690

Browse files
committed
update readme
1 parent ebf7feb commit 9a89690

File tree

1 file changed

+32
-2
lines changed

1 file changed

+32
-2
lines changed

README.md

Lines changed: 32 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,13 @@ npm install -g ezshare
2626

2727
If you don't want to install Node.js, you can download Electron based executable of `ezshare` from Releases.
2828

29+
## Migrate from v1 to v2
30+
31+
```bash
32+
npm uninstall -g ezshare
33+
npm i -g @ezshare/cli
34+
```
35+
2936
## Usage
3037

3138
- Open a terminal and run:
@@ -87,9 +94,32 @@ yarn build && yarn workspace @ezshare/electron package
8794

8895
## Release
8996

90-
- Push and wait for green GitHub Actions
97+
First push and wait for green GitHub Actions.
98+
99+
Version whichever packages are changed:
100+
101+
```bash
102+
yarn workspace @ezshare/web version patch
103+
yarn workspace @ezshare/lib version patch
104+
yarn workspace @ezshare/cli version patch
105+
yarn workspace @ezshare/electron version patch
106+
107+
git add packages/*/package.json
108+
git commit -m Release
109+
```
110+
111+
Now build and publish to npm:
112+
113+
```bash
114+
yarn build
115+
yarn workspace @ezshare/web npm publish
116+
yarn workspace @ezshare/lib npm publish
117+
yarn workspace @ezshare/cli npm publish
118+
```
119+
120+
Now trigger workflow dispatch to build the Electron version.
91121
- Wait for GitHub Actions run
92-
- Edit draft to add release notes, and check that artifacts get added.
122+
- Edit draft to add release notes, and check that artifacts got added.
93123

94124
## Credits
95125
- Icon made by [Freepik](https://www.flaticon.com/authors/freepik) from [www.flaticon.com](https://www.flaticon.com/)

0 commit comments

Comments
 (0)