Skip to content
This repository has been archived by the owner on Oct 22, 2021. It is now read-only.

Commit

Permalink
add info to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Simon-Laux committed Sep 8, 2020
1 parent 665b991 commit 7952697
Showing 1 changed file with 21 additions and 1 deletion.
22 changes: 21 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,13 +41,33 @@ offline version

<a href="https://www.buymeacoffee.com/vj6Q8lR" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/lato-orange.png" alt="Buy Me A Coffee" style="height: 25px !important;width: 108px !important;" ></a>

## Contributing

### Setup

first install the dependencies

```sh
npm install
```

### Packaging

This only works on linux(and maybe osx) at the moment

```sh
npm i
npm run package
```

The resulting package can be found in the build folder.

### Formatting

This project uses code formatting. Make sure to run the formatter before commiting, otherwise the CI will be sad 😢.

```sh
# check it
npm run formatting:test
# run the formatter
npm run formatting:fix
```

0 comments on commit 7952697

Please sign in to comment.