diff --git a/README.md b/README.md index 6e9f7bc..eb12e40 100644 --- a/README.md +++ b/README.md @@ -41,13 +41,33 @@ offline version Buy Me A Coffee +## 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 +```