From 80bd85fc8d7ee3341a7e6e67f8b958ed45468d74 Mon Sep 17 00:00:00 2001 From: Jos de Jong Date: Tue, 16 Jan 2024 09:22:17 +0100 Subject: [PATCH] docs: reorganize the Develop section in the README.md --- README.md | 69 +++++++++++-------------------------------------------- 1 file changed, 14 insertions(+), 55 deletions(-) diff --git a/README.md b/README.md index 85c56129..9054b027 100644 --- a/README.md +++ b/README.md @@ -653,68 +653,27 @@ const config = { ## Develop -Clone the git repository +To get started: clone the git repository, run `npm install`, and then `npm run dev`. -Install dependencies (once): +All available scripts: ``` -npm install -``` +npm install # Install dependencies (once) -Start the demo project (at http://localhost:5173): +npm run dev # Start the demo project (at http://localhost:5173) +npm run build # Build the library (output in ./package and ./package-vanilla) -``` -npm run dev -``` +npm run test # Run unit tests in watch mode +npm run test-ci # Run unit tests once +npm run coverage # Run unit test coverage (output in ./coverage) -Build the library: +npm run lint # Run linter +npm run format # Automatically fix linting issues -``` -npm run build -``` - -Run unit tests (in watch mode): - -``` -npm test -``` - -Run unit tests and exit: - -``` -npm run test-ci -``` - -Run linter: - -``` -npm run lint -``` - -Run coverage (coverage results will be generated in the folder `./coverage`): - -``` -npm run coverage -``` - -Automatically fix linting issues: - -``` -npm run format -``` - -Publish to npm (will increase version number and publish to npm): - -``` -npm run release -``` - -Note that it will publish two npm packages: `svelte-jsoneditor` and `vanilla-jsoneditor`. You'll need to enter a one-time password for npm. - -To try a build and see the change list, run: - -``` -npm run release-dry-run +npm run release-dry-run # To run the build and see the change list without actually publishing +npm run release # Publish to npm. Will increase version number, update changelog, etc. + # Note that it will publish two npm packages: `svelte-jsoneditor` and + # `vanilla-jsoneditor`. You'll need to enter a one-time password for npm. ``` ## License