Skip to content

Commit

Permalink
docs: reorganize the Develop section in the README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
josdejong committed Jan 16, 2024
1 parent b652737 commit 80bd85f
Showing 1 changed file with 14 additions and 55 deletions.
69 changes: 14 additions & 55 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 80bd85f

Please sign in to comment.