Skip to content

Commit 4bb21ff

Browse files
committed
Update docs
1 parent d855cac commit 4bb21ff

File tree

6 files changed

+22
-47
lines changed

6 files changed

+22
-47
lines changed

README.md

+13-6
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,23 @@ A set of libraries and recipes to make frontend development easier thanks to Eff
1010
- install deps via `pnpm install`
1111
- make changes
1212
- make sure that your changes is passing checks:
13-
- run tests via `pnpm test`
14-
- run type tests via `pnpm test:types`
15-
- try to build it via `pnpm build`
16-
- format code via `pnpm format`
17-
- fill in changes via `pnpm changes`
13+
- run tests via `pnpm run -r test:run`
14+
- try to build it via `pnpm run -r build`
15+
- format code via `pnpm run format:check`
16+
- fill in changes via `pnpm changeset`
1817
- open a PR
1918
- enjoy 🎉
2019

2120
### Release workflow
2221

23-
Releases of With Ease are automated by [changesets](https://github.com/changesets/changesets) and GitHub Actions. Your only duty is creating changeset for every PR, it is controlled by [Changes-action](./.github/workflows/changes.yml).
22+
Releases of Farfetched are automated by [changesets](https://github.com/changesets/changesets) and GitHub Actions. Your only duty is creating changeset for every PR, it is controlled by [Changes-action](./.github/workflows/changes.yml).
2423

2524
After merging PR to master-branch, [Version-action](./.github/workflows/version.yml) will update special PR with the next release. To publish this release, just merge special PR and wait, [Release-action](./.github/workflows/release.yml) will publish packages.
25+
26+
### Repository management
27+
28+
#### New package creation
29+
30+
Copy-paste `packages/web-api` directory, rename it to the package name. Then, update `package.json`, `README.md` and `vite.config.js` files. Then, delete `CHANGELOG.md` file and any other files that are not needed in the new package.
31+
32+
Fancy generator will be added in the future.

apps/web-api-demo/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,4 @@
55
- clone the repo
66
- ensure that `pnpm` is installed
77
- install dependencies via `pnpm install`
8-
- start showcase via `pnpm nx serve web-api-demo`
8+
- start showcase via `pnpm --filter web-api-demo dev`

packages/factories/README.md

+2-10
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,3 @@
1-
# factories
1+
# @withease/factories
22

3-
This library was generated with [Nx](https://nx.dev).
4-
5-
## Building
6-
7-
Run `nx build factories` to build the library.
8-
9-
## Running unit tests
10-
11-
Run `nx test factories` to execute the unit tests via [Jest](https://jestjs.io).
3+
Read documentation [here](https://withease.pages.dev/factories/).

packages/i18next/README.md

+2-10
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,3 @@
1-
# i18next
1+
# @withease/i18next
22

3-
This library was generated with [Nx](https://nx.dev).
4-
5-
## Building
6-
7-
Run `nx build i18next` to build the library.
8-
9-
## Running unit tests
10-
11-
Run `nx test i18next` to execute the unit tests via [Jest](https://jestjs.io).
3+
Read documentation [here](https://withease.pages.dev/i18next/).

packages/redux/README.md

+2-10
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,3 @@
1-
# redux
1+
# @withease/redux
22

3-
This library was generated with [Nx](https://nx.dev).
4-
5-
## Building
6-
7-
Run `nx build redux` to build the library.
8-
9-
## Running unit tests
10-
11-
Run `nx test redux` to execute the unit tests via [Jest](https://jestjs.io).
3+
Read documentation [here](https://withease.pages.dev/redux/).

packages/web-api/README.md

+2-10
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,3 @@
1-
# web-api
1+
# @withease/web-api
22

3-
This library was generated with [Nx](https://nx.dev).
4-
5-
## Building
6-
7-
Run `nx build web-api` to build the library.
8-
9-
## Running unit tests
10-
11-
Run `nx test web-api` to execute the unit tests via [Jest](https://jestjs.io).
3+
Read documentation [here](https://withease.pages.dev/web-api/).

0 commit comments

Comments
 (0)