Information about publishing

README.md

@@ -1,6 +1,7 @@
 # Luupzig
 
-This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 12.0.5.
+[![Actions Status](https://github.com/UUDigitalHumanitieslab/luupzig/workflows/Unit%20tests/badge.svg)](https://github.com/UUDigitalHumanitieslab/luupzig/actions)
+[![npm version](https://badge.fury.io/js/luupzig.svg)](https://badge.fury.io/js/luupzig)
 
 This project consists of:
 
@@ -13,7 +14,7 @@ This project consists of:
 
 Run `yarn build library` first.
 
-Run `yarn start` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.
+Run `yarn start` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files of the frontend. If you make any changes to the library then you will need to rebuild the library and restart the dev server.
 
 ## Code scaffolding
 
@@ -27,12 +28,16 @@ Run `yarn build library` to build the project. The build artifacts will be store
 
 ## Running unit tests
 
-Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io).
-
-## Running end-to-end tests
-
-Run `ng e2e` to execute the end-to-end tests via a platform of your choice. To use this command, you need to first add a package that implements end-to-end testing capabilities.
+Run `yarn test` to execute the unit tests via [Karma](https://karma-runner.github.io).
 
 ## Further help
 
 To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI Overview and Command Reference](https://angular.io/cli) page.
+
+## Publishing a new version
+
+1. Compile using `yarn build library`
+2. `cd dist/luupzig`
+3. Optionally run `npm pack` to test the package locally
+4. Remove the `luupzig-x.xx.x.tgz` file (if generated in 3)
+5. Run `npm publish`