[UPD] v1.0.0

.github/workflows/linters.yml

@@ -29,23 +29,7 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           VALIDATE_ALL_CODEBASE: true
           VALIDATE_JSCPD: false
+          VALIDATE_CHECKOV: false
+          VALIDATE_BASH_EXEC: false
           VALIDATE_GO: false
           VALIDATE_GO_MODULES: false
-  golangci-lint:
-    name: Lint Golang
-    runs-on: ubuntu-latest
-    steps:
-      - name: Setup Go
-        uses: actions/setup-go@v5
-        with:
-          go-version: 1.22
-      - name: Checkout Code
-        uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-      - name: Install dependencies
-        run: go mod tidy
-      - name: Run golangci-lint
-        uses: golangci/golangci-lint-action@v6
-        with:
-          args: --timeout=3m

README.md

@@ -1,2 +1,53 @@
-# sevdesk
-sevDesk API SDK
+# 📖 sevDesk
+
+[![License](https://img.shields.io/badge/License-BSD_3--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)
+[![Linters](https://github.com/plaenkler/sevdesk/actions/workflows/linters.yml/badge.svg)](https://github.com/plaenkler/sevdesk/actions/workflows/linters.yml)
+[![Go Reference](https://pkg.go.dev/badge/github.com/Plaenkler/sevDesk.svg)](https://pkg.go.dev/github.com/Plaenkler/sevDesk)
+[![Support me](https://img.shields.io/badge/Support%20me%20%E2%98%95-orange.svg)](https://www.buymeacoffee.com/Plaenkler)
+
+## 🎯 Purpose
+
+- Maintain updated and reliable Go bindings for the [sevDesk API](https://api.sevdesk.de/).
+- Simplify integration with sevDesk for Go developers by providing:
+  - **Generated Go types** for the API data models.
+  - **A client implementation** for interacting with the API.
+  - **Server boilerplate code** for custom API handling.
+
+## 🚀 Installation
+
+Install the package in your Go project:
+
+```bash
+go get github.com/Plaenkler/sevDesk
+```
+
+## 📚 Contribution
+
+If you notice that this Golang package is out of date with the latest sevDesk OpenAPI definition please feel free to submit a pull request.
+Here’s how you can help:
+
+### 🛠 **Updating API Bindings**
+
+To update the Go bindings based on the latest sevDesk OpenAPI definition, follow these steps:
+
+1. **Fork the repository**  
+   Create a personal copy of this repository by forking it.
+   This will allow you to make changes without affecting the original project.
+
+2. **Create a new branch**  
+   Before making any changes, create a new branch with a descriptive name (e.g. `update-api-bindings-v2.X.X`).
+
+3. **Run the Update Script**  
+   We’ve provided an update script that automatically generates Go bindings from the sevDesk OpenAPI specification.
+   Run the script by executing:
+   ```bash
+   ./update_bindings.sh
+   ```
+   This will generate updated Go types and client code based on the latest API schema.
+
+4. **Commit and push the updated files**  
+   After running the update script, review the changes and commit them with a clear message (e.g. `[UPD] Bindings for sevDesk v2.X.X`).
+   Then, push the changes to your fork.
+
+5. **Open a Pull Request**  
+   Submit a pull request with your changes.

SECURITY.md

@@ -2,22 +2,21 @@
 
 ## Supported Versions
 
-I am dedicated to ensure the security of sevDesk. To achieve this, I follow the Calendar Versioning (CalVer) scheme, where revisions are in the format "yy/week of year/revision".
-I will only support the latest revision of each of the last three calendar weeks. Explanatory diagram:
+I am dedicated to ensure the security of sevDesk. To achieve this, I follow the Semantic Versioning (SemVer) scheme, where revisions are in the format "major.minor.patch".
+I will release patches for any security vulnerabilities that are discovered in the latest major or minor release.
 
-| Version      | Supported          |
-| ------------ | ------------------ |
-| 2023.30.2    | :white_check_mark: |
-| 2023.30.1    | :x: |
-| 2023.29.2    | :white_check_mark: |
-| 2023.28.4    | :white_check_mark: |
-| Older        | :x:                |
+| Version | Supported          |
+| ------- | ------------------ |
+| 1.2.x   | :white_check_mark: |
+| 1.1.x   | :x:                |
+| 1.0.x   | :white_check_mark: |
+| < 1.0   | :x:                |
 
 ## Reporting a Vulnerability
 
 I take the security of this project very seriously. If you discover a security vulnerability, I appreciate your responsible disclosure. To report a vulnerability, please follow these steps:
 
-1. **Email**: Send an email to [info@plaenker.com](mailto:info@plaenker.com) with all the details regarding the vulnerability.
+1. **Email**: Send an email to [info@plaenkler.com](mailto:info@plaenkler.com) with all the details regarding the vulnerability.
 2. **Subject**: Use "[sevDesk Vulnerability Report]" as the subject line to help me prioritize and identify your report.
 3. **Vulnerability Details**: Please provide a clear and detailed description of the vulnerability, along with the potential impact it may have.
 4. **Reproducibility**: If possible, include step-by-step instructions to reproduce the vulnerability.
@@ -40,10 +39,11 @@ If the vulnerability is declined:
 
 ## Security Updates
 
-To ensure the security of sevDesk, it is crucial that all users update to the latest supported version promptly. Users of older versions that are no longer supported are strongly recommended to upgrade to a supported version to stay protected against potential security threats.
+To ensure the security of sevDesk, it is crucial that all users update to the latest supported version promptly.
+Users of older versions that are no longer supported are strongly recommended to upgrade to a supported version to stay protected against potential security threats.
 
 Thank you for helping me make sevDesk more secure. Your cooperation and responsible disclosure are essential to maintaining the integrity and trustworthiness of this project.
 
 Please note that this security policy is subject to change over time, so it is advisable to check this document periodically for any updates.
 
-Last Updated: July 31, 2023.
+Last Updated: December 30, 2024.