docs: add badges

Author: jankapunkt

README.md

@@ -2,49 +2,50 @@
 
 The user manual / documentation of OpenQDA
 
-[![Deploy to GitHub Pages](https://github.com/openqda/user-docs/actions/workflows/deploy.yml/badge.svg)](https://github.com/openqda/user-docs/actions/workflows/deploy.yml)
+[![Deploy VitePress site to Pages](https://github.com/openqda/user-docs/actions/workflows/deploy.yml/badge.svg)](https://github.com/openqda/user-docs/actions/workflows/deploy.yml)
 ![GitHub License](https://img.shields.io/github/license/openqda/user-docs)
+[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
+![This is a research software documentation](https://img.shields.io/badge/software-documentation-blue?style=plastic)
+[![DOI](https://zenodo.org/badge/768506301.svg)](https://doi.org/10.5281/zenodo.11518216)
+
 
 ## Website
 
 The documentation is available under https://openqda.github.io/user-docs/
 
-It's built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
+It's built using [vitepress](https://vitepress.dev), a modern static website generator for documentations.
 
 ### Installation
 
 ```
-$ yarn
+$ npm install
 ```
 
 ### Local Development
 
 ```
-$ yarn start
+$ npm run docs:dev
 ```
 
 This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
 
 ### Build
 
 ```
-$ yarn build
+$ npm run docs:build
+$ npm run docs:preview # optional to locally peview your build output
 ```
 
-This command generates static content into the `build` directory and can be served using any static contents hosting service.
 
 ### Deployment
+We use GitHub actions to automatically deploy updates to GitHub pages.
+Any merges to `main` will trigger a new build to be deployed.
+Pull requests, however will not trigger builds.
 
-Using SSH:
-
-```
-$ USE_SSH=true yarn deploy
-```
+### Contributing
+We welcome your contribution and appreciate your support!
+Please read our contribution guidelines in order to make your contribution a success.
 
-Not using SSH:
-
-```
-$ GIT_USER=<Your GitHub username> yarn deploy
-```
+## License
 
-If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
+See [license file](./LICENSE)