docs: update readme

CHANGELOG.md

@@ -4,3 +4,107 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html) and [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/).
+
+
+## v1.1.0 (2024-07-16)
+
+#### 🎁 Feature
+
+* Add checksum verification (5884a154)
+
+#### 🔁 CI
+
+* run goreleaser only if new release (9485e929)
+* use v2 for goreleaser action (7b8a72c3)
+* use v6 for goreleaser (25591d36)
+* update release workflow (88c916ab)
+* update release workflow (4d6686b1)
+
+
+## v1.0.6 (2024-07-08)
+
+#### 🐞 Bug Fixes
+
+* Use goreleaser for publishing (8fa9fc1c)
+
+#### 📄 Documentation
+
+* update readme (a0e882be)
+* update readme (f0707053)
+
+#### 🚧 Chores
+
+* **deps:** bump codecov/codecov-action from 4.0.1 to 4.5.0 (#1) (4ec78448)
+
+
+## v1.0.5 (2024-07-08)
+
+#### 🐞 Bug Fixes
+
+* Remove sem-rel config (ad86fbb0)
+
+#### 🔁 CI
+
+* update workflow (0bacbbeb)
+
+
+## v1.0.4 (2024-07-08)
+
+#### 🐞 Bug Fixes
+
+* Min req set to go1.15 (6122c5d1)
+
+#### 📄 Documentation
+
+* Add issue templates (5ea945cb)
+
+#### 🔎 Tests
+
+* Add codecov for downloader.go (c86aa3b7)
+
+#### 🔁 CI
+
+* correct publish step (9ee10fd2)
+* Improved codecov for pkg (f08e6459)
+
+
+## v1.0.3 (2024-07-06)
+
+#### Bug Fixes
+
+* correct regex patterns in config.go (28235f5d)
+
+#### CI
+
+* fix codecov workflow (f3e43a26)
+* update codecov workflow (5a1453a8)
+* update codecov (c9325dcc)
+
+
+## v1.0.2 (2024-07-06)
+
+#### Bug Fixes
+
+* update main script and pkg (ba5c3c8f)
+
+#### Chores
+
+* update sem-rel (d0b7a490)
+
+
+## v1.0.1 (2024-07-05)
+
+#### Bug Fixes
+
+* sem release plugin (27280f95)
+
+
+## v1.0.0 (2024-07-05)
+
+#### Chores
+
+* Add code for goautomate (da3146c3)
+
+#### CI
+
+* Update release workflow (5e897b15)

README.md

@@ -1,4 +1,4 @@
-# GoAutomate
+# GoAutomate🐿️
 
 [![Release](https://github.com/Nicconike/goautomate/actions/workflows/release.yml/badge.svg)](https://github.com/Nicconike/goautomate/actions/workflows/release.yml)
 [![Code Coverage](https://github.com/Nicconike/goautomate/actions/workflows/coverage.yml/badge.svg)](https://github.com/Nicconike/goautomate/actions/workflows/coverage.yml)
@@ -32,11 +32,16 @@ go install github.com/Nicconike/goautomate/cmd/goautomate@latest
 ### Basic Usage
 
 ```sh
-goautomate -file <path-to-file>
+goautomate -file <path-to-file> -os <target-os> -arch <target-arch>
 ```
 
 This will check the specified file for the current Go version, compare it with the latest available version, and download the new version if an update is available.
 
+> [!NOTE]
+> If you don't specify the `os` and `arch` type, the tool will download the latest version for your current operating system and architecture.
+>
+> Minimum required Go version: 1.15
+
 ### Command-line Options
 
 - `-file` or `-f`: Path to the file containing the current Go version
@@ -48,25 +53,25 @@ This will check the specified file for the current Go version, compare it with t
 
 1. Get version from a Dockerfile:
 	```sh
-	goautomate -file Dockerfile
+	goautomate -f Dockerfile
 	```
 	![Dockerfile Example](https://github.com/Nicconike/goautomate/blob/master/assets/dockerfile_example.png)
 
 2. Get version from go.mod:
 	```sh
-	goautomate -file go.mod
+	goautomate -f go.mod
 	```
 	![Go Mod Example](https://github.com/Nicconike/goautomate/blob/master/assets/gomod_example.png)
 
 3. Specify version directly:
 	```sh
-	goautomate -version 1.16.5
+	goautomate -v 1.17
 	```
 	![Direct Example](https://github.com/Nicconike/goautomate/blob/master/assets/direct_example.png)
 
 4. Download for a specific OS and architecture:
 	```sh
-	goautomate -file version.json -os linux -arch arm64
+	goautomate -f version.json -os linux -arch arm64
 	```
 	![JSON Example with OS](https://github.com/Nicconike/goautomate/blob/master/assets/json_example_os_arch.png)
 
@@ -79,7 +84,7 @@ This will check the specified file for the current Go version, compare it with t
 - JSON configuration files
 - Plain text files with version information
 
-The tool uses various patterns to detect Go versions, making it flexible for different project setups.
+The tool uses various regex patterns to detect Go versions, making it flexible for different project setups.
 
 Missing any file types you expected to see? Let me know via [discussions](https://github.com/Nicconike/goautomate/discussions) or [discord server](https://discord.gg/UbetHfu).