update readme with information about the project and usage instructions

add information about custom shortcodes exclusively for Verua.CH

readme.md

@@ -1,11 +1,80 @@
-<h1 align="center">Verua.CH Website </h1>
+# Verua.CH Website
 
+ <a href="https://github.com/gohugoio/hugo/releases/tag/v0.124.1" alt="Contributors">
+    <img src="https://img.shields.io/static/v1?label=min-HUGO-version&message=0.121.2&color=f00&logo=hugo" />
+  </a>
+  <a href="https://go.dev" alt="Contributors">
+    <img src="https://img.shields.io/static/v1?label=min-go-version&message=1.20.5&color=f00&logo=go" />
+  </a>
+    <a href="https://go.dev" alt="Contributors">
+    <img src="https://img.shields.io/static/v1?label=min-node-version&message=20&color=f00&logo=npm" />  
+  </a>
 
-<h3 align="center">👀 currently under development on:  <a target="_blank" href="https://verua.dev-1.andreashnida.de/" rel="nofollow"> verua.dev-1.andreashnida.de</a>
+<h3 >currently under development on:  <a target="_blank" href="https://verua.dev-1.andreashnida.de/" rel="nofollow"> verua.dev-1.andreashnida.de 👀 </a>
 </h3>
-<center>
-Development site: <a target="_blank" href="https://preview.verua.info/" rel="nofollow">preview.verua.info</a> //  
+
+Development site: <a target="_blank" href="https://preview.verua.info/" rel="nofollow">preview.verua.info</a>  
 Production site: <a target="_blank" href="https://verua.info/" rel="nofollow">verua.info</a>
 
-This site is based on <a href="https://github.com/zeon-studio/hugoplate">Hugoplate Boilerplate Theme</a>
-</center>
+ℹ This site is based on <a href="https://github.com/zeon-studio/hugoplate">Hugoplate Boilerplate Theme for Hugo</a>. For specifics on how to use the theme, please refer to the <a href="https://github.com/zeon-studio/hugoplate/blob/main/README.md">README</a> of the theme.
+
+## Usage / Update Content
+
+To use the theme, you need to clone the repository, update your content in the content folder and push your changes to the main branch.
+
+```bash
+# Clone the repository
+git clone https://code.verua.online/rabeweb/verua.ch_src.git
+
+# connect to your gitea instance
+cd verua.ch_src
+git remote add origin https://code.verua.online/rabeweb/verua.ch_src.git
+git push -u origin main
+```
+
+### Deployment
+
+Deployment is done via Gitea Runners. The deployment is triggered by a push to the `main` branch. The deployment will automatically build the site and deploy it to the production or preview environment.
+
+You can control where the site is deployed by setting the 'params.environment' variable in the `hugo.toml` file. The value should be either `production` or `development`.
+
+This also controls the creation of the robots.txt file. If the value is `development`, the robots.txt file will be created with the following content:
+
+```
+User-agent: *
+Disallow: /
+```
+
+Credentials and targets are stored as secrets in your Gitea instance.
+
+You can also run the site locally. Please refer to the 'Development' section for more information.
+
+ℹ You will find the workflow file in `/.gitea/workflows/build-and-deploy-pipeline.yaml`
+
+### Development
+
+To run the site locally, you can use the following commands:
+
+```bash
+# Install dependencies
+npm install
+
+# Start the development server
+npm run dev
+```
+
+The site will be available at `http://localhost:8080`.
+
+## Features
+
+### Custom Shortcodes exclusively for Verua.CH
+
+<small>/themes/hugoplate/layouts/shortcodes/</small>
+
+- **Alerts**: Create alerts with custom text and styles.
+- **Aligncenter**: Center content horizontally.
+- **Buttons**: Create buttons with custom text and styles.
+- **Cards**: Create beautiful cards with custom content and images.
+- **Columns**: Create responsive columns with custom content and images.
+- **Icons**: Use icons from the Font Awesome library to add icons to your website.
+- **Sections**: Create sections with custom content and images.