fix: readme

Everyone should be happy now!

.github/workflows/build.yml

@@ -81,11 +81,13 @@ jobs:
       uses: ietf-tools/semver-action@v1
       with:
         token: ${{ secrets.GITHUB_TOKEN }}
-        branch: master
+        branch: master            # ← change to "main" if that's your default
-        patchAll: true  # Always increment patch number
+        patchAll: true
+        # fallbackTag: v0.0.1     # ← optionally bootstrap from an existing tag
 
     - name: Create GitHub Release
       if: ${{ github.event.inputs.create_release != 'false' }}
+      id: create_release         # ← this is required
       uses: actions/create-release@v1
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
@@ -95,6 +97,21 @@ jobs:
         draft: false
         prerelease: false
 
+    - name: Zip the build for github release
+      if: ${{ github.event.inputs.create_release != 'false' }}
+      run: Compress-Archive -Path './output/*' -DestinationPath './output/HomeScreen_Build_${{ steps.semver.outputs.next }}.zip' -CompressionLevel Optimal -Force
+
+    - name: Upload Release Asset
+      if: ${{ github.event.inputs.create_release != 'false' }}
+      uses: actions/upload-release-asset@v1
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      with:
+        upload_url: ${{ steps.create_release.outputs.upload_url }}    # ← now available
+        asset_path: ./output/HomeScreen_Build_${{ steps.semver.outputs.next }}.zip
+        asset_name: HomeScreen_Build_${{ steps.semver.outputs.next }}.zip
+        asset_content_type: application/zip
+      
     - name: Generate appsettings.json
       run: |
         $appSettings = @{

HomeApi.sln

@@ -7,6 +7,12 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "HomeApi", "HomeApi\HomeApi.csproj", "{0F340BDE-7B8E-4ACD-8A24-5B5BFFB424F4}"
 EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "ESP32_CODE", "ESP32_CODE", "{B3BCE85B-5021-4D4D-8758-CA7AAFF86C2D}"
+	ProjectSection(SolutionItems) = preProject
+		Esp32_Code\ESPSCREEN\ESPSCREEN.ino = Esp32_Code\ESPSCREEN\ESPSCREEN.ino
+		Esp32_Code\INFOSCREEN_WITH_INTERVAL\INFOSCREEN_WITH_INTERVAL.ino = Esp32_Code\INFOSCREEN_WITH_INTERVAL\INFOSCREEN_WITH_INTERVAL.ino
+	EndProjectSection
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -20,5 +26,6 @@ Global
 	EndGlobalSection
 	GlobalSection(NestedProjects) = preSolution
 		{0F340BDE-7B8E-4ACD-8A24-5B5BFFB424F4} = {FF03E920-D5E9-4BE0-AA6F-DB2E9287D3E4}
+		{B3BCE85B-5021-4D4D-8758-CA7AAFF86C2D} = {FF03E920-D5E9-4BE0-AA6F-DB2E9287D3E4}
 	EndGlobalSection
 EndGlobal

HomeApi/HomeApi.csproj

@@ -20,6 +20,7 @@
     </ItemGroup>
 
     <ItemGroup>
+      <Content Include="..\README.md" />
       <Content Include="..\.dockerignore">
         <Link>.dockerignore</Link>
       </Content>

README.md

@@ -1,4 +1,141 @@
-# This [![Build and Deploy](https://github.com/Myxelium/HomeScreen/actions/workflows/build.yml/badge.svg)](https://github.com/Myxelium/HomeScreen/actions/workflows/build.yml)
+[![myxelium - homescreen](https://img.shields.io/static/v1?label=myxelium&message=homescreen&color=purple&logo=github)](https://github.com/myxelium/homescreen "Go to GitHub repo")
-Core api and Esp32 code for displaying weather data and public transport information on a e-ink display.
+[![stars - homescreen](https://img.shields.io/github/stars/myxelium/homescreen?style=social)](https://github.com/myxelium/homescreen)
+[![forks - homescreen](https://img.shields.io/github/forks/myxelium/homescreen?style=social)](https://github.com/myxelium/homescreen)
+[![GitHub tag](https://img.shields.io/github/tag/myxelium/homescreen?include_prereleases=&sort=semver&color=purple)](https://github.com/myxelium/homescreen/releases/)
+[![License](https://img.shields.io/badge/License-GPL-purple)](https://www.gnu.org/licenses/gpl-3.0.en.html)
+[![issues - homescreen](https://img.shields.io/github/issues/myxelium/homescreen)](https://github.com/myxelium/homescreen/issues)
+[![Build and Deploy](https://github.com/Myxelium/HomeScreen/actions/workflows/build.yml/badge.svg)](https://github.com/Myxelium/HomeScreen/actions/workflows/build.yml)
+# What why how
+This is a project I created that pulls weather data from the internet, transforms it into custom images, and displays them on an e-ink screen powered by an ESP32.
+
+## What This Project Does
+
+I wanted a low-power way to see weather information at a glance, so I built this system that:
+
+- Fetches real-time weather data from online APIs
+- Processes and converts the data into visual images (temperature graphs, forecast icons, etc.)
+- Sends these images wirelessly to an ESP32 microcontroller
+- Displays the information on an energy-efficient e-ink screen
+- Updates periodically while consuming minimal power
 
 <img width="800" height="480" alt="image" src="https://github.com/user-attachments/assets/ef5af0c6-ea3a-494d-b2af-3de6e70b3e6a" />
+
+## Git Notes
+All commits has to follow this [Conventional Commits style](https://www.conventionalcommits.org/) to pass the pipeline.
+## Features 😺
+- Display current weather data
+- Display public transport information
+- Display time and date
+
+## Requirements 🫥
+- [ESP32 board](https://www.waveshare.com/wiki/E-Paper_ESP32_Driver_Board)
+- [E-ink display (e.g. Waveshare 7.5 inch)](https://www.waveshare.com/7.5inch-e-paper-hat.htm)
+
+# Installation
+
+This section provides instructions for setting up and running the HomeApi project.
+
+## Prerequisites
+
+- [.NET 9.0 SDK](https://dotnet.microsoft.com/download/dotnet/9.0) or later
+- Docker (optional, for containerized deployment)
+- Git (to clone the repository)
+
+## Option 1: Local Development Setup
+
+1. Clone the repository:
+   ```bash
+   git clone https://github.com/Myxelium/HomeScreen.git
+   cd HomeApi
+   ```
+
+2. Restore dependencies:
+   ```bash
+   dotnet restore
+   ```
+
+3. Build the project:
+   ```bash
+   dotnet build
+   ```
+
+4. Run the application:
+   ```bash
+   dotnet run
+   ```
+
+The API will be available at `http://localhost:5000`.
+
+## Option 2: Docker Deployment
+
+1. Build the Docker image:
+   ```bash
+   docker build -t homeapi .
+   ```
+
+2. Run the container:
+   ```bash
+   docker run -d -p 5000 --name homeapi homeapi
+   ```
+
+The API will be accessible at `http://localhost:5000`.
+
+## Configuration
+
+The application uses the standard .NET configuration system. You can modify settings in:
+
+- `appsettings.json` - Default configuration
+- `appsettings.Development.json` - Development environment configuration
+
+API endpoints:
+- Weather data: GET `/home`
+- Generated image: GET `/home/default.jpg`
+- Configuration data: GET `/home/configuration`
+- Departure board: GET `/home/departure-board`
+
+## API Documentation
+
+When running, API documentation is available through Scalar at `/scalar`.
+
+```mermaid
+flowchart TD
+subgraph ESP32 Device
+ESP[ESP32 E-Ink Display]
+ESP -->|HTTP GET /home/configuration| API
+ESP -->|HTTP GET /home/default.jpg| API
+end
+
+    subgraph HomeApi
+        API[HomeControllerAPI]
+        API -->|MediatR| Handlers
+        Handlers -->|Service Calls| Services
+        Services -->|Refit Http Clients| Clients
+        Clients -->|External APIs| ExtAPIs
+        API -->|Returns JSON/JPEG| ESP
+    end
+
+    subgraph ExternalAPIs
+        WeatherAPI[Weather API]
+        AuroraAPI[Aurora API]
+        NominatimAPI[Nominatim API]
+        ResRobotAPI[ResRobot API]
+    end
+
+    ExtAPIs -.-> WeatherAPI
+    ExtAPIs -.-> AuroraAPI
+    ExtAPIs -.-> NominatimAPI
+    ExtAPIs -.-> ResRobotAPI
+```
+
+# ESP32 configuration and building
+<img width="4096" height="1842" alt="image" src="https://github.com/user-attachments/assets/5acf1b3b-f9bb-48bd-b310-a2852544eaba" />
+
+Best way of getting the ESP32 ready for code upload is to follow this guide [WAVESHARE ESP32 GUIDE](https://web.archive.org/web/20250706150325/https://www.waveshare.com/wiki/E-Paper_ESP32_Driver_Board).
+Once you have it ready so you can upload code to it copy my code in: Esp32_Code/INFOSCREEN_WITH_INTERVAL from this repo.
+
+Install following libraries (if more is needed search for them and install them too): 
+* ArduinoJson
+* GUI_Paint
+* JPEGDEC
+
+You need the Waveshare examples installed since it uses code from them download them here [Download](https://files.waveshare.com/upload/5/50/E-Paper_ESP32_Driver_Board_Code.7z) or check above link.

compose.yaml

@@ -1,13 +1,15 @@
-services:
+version: '3.8'
-  homeapi:
-    image: homeapi
-    build:
-      context: .
-      dockerfile: Dockerfile
 
-  homeapi-1:
+services:
-    image: homeapi-1
+  homeapi:
     build:
       context: .
       dockerfile: HomeApi/Dockerfile
-
+    image: homeapi:latest
+    ports:
+      - "5000:5000"
+    environment:
+      - ASPNETCORE_ENVIRONMENT=Development
+    volumes:
+      - ./HomeApi/appsettings.Development.json:/app/appsettings.Development.json:ro
+    restart: unless-stopped