Skip to content

Commit 0ae748b

Browse files
committed
docs: update README
1 parent a9877cd commit 0ae748b

File tree

1 file changed

+9
-15
lines changed

1 file changed

+9
-15
lines changed

README.md

Lines changed: 9 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ Before you open a PR, please make sure your changes comply with the following ru
4141

4242
You can use the commit [feat: add portuguese translation](https://github.com/abichinger/vue-js-cron/commit/64fbe1e7b30bd07e4e61b11cf98292f1cc81bfd4) as a reference.
4343

44-
[Here](https://abichinger.github.io/vue-js-cron/api/core.html#types) you can find the structure of a localization object.
44+
[Here](https://abichinger.github.io/vue-js-cron/typedoc/interfaces/_vue_js_cron_core.Localization.html) you can find the structure of a localization object.
4545

4646
## Contributors
4747
<a href="https://github.com/abichinger/vue-js-cron/graphs/contributors">
@@ -57,31 +57,25 @@ npm install
5757

5858
## Scripts
5959
```bash
60+
# Build packages, demo and docs
61+
npm run build -w=core # Build the core package, required by other packages
62+
npm run build # builds all public packages
63+
npm run build-demo # build demo, embedded inside docs
64+
npm run build-docs # build documentaion using vuepress
65+
6066
# Start a developement server for the core package
6167
npm run dev -w=core
6268

63-
# Build the core package, required by other packages
64-
npm run build -w=core
65-
6669
# Run the development server of @vue-js-cron/light
6770
npm run dev -w=light
6871

6972
# Start a development server of the documentation
7073
cd docs && npm run dev
7174

72-
# Have a look at package.json for more scripts
73-
```
74-
75-
## Test
76-
```bash
75+
# Run tests
7776
npm run test
78-
```
7977

80-
## Build
81-
```bash
82-
npm run build # builds all public packages
83-
npm run build-demo # build demo, embedded inside docs
84-
npm run build-docs # build documentaion using vuepress
78+
# Have a look at package.json for more scripts
8579
```
8680

8781
## Attribution

0 commit comments

Comments
 (0)