docs: Update README.md

Author: pythoninthegrass

README.md

@@ -1,6 +1,6 @@
-# Go Repository Template
+# twu
 
-[![Keep a Changelog](https://img.shields.io/badge/changelog-Keep%20a%20Changelog-%23E05735)](CHANGELOG.md)
+<!-- [![Keep a Changelog](https://img.shields.io/badge/changelog-Keep%20a%20Changelog-%23E05735)](CHANGELOG.md)
 [![GitHub Release](https://img.shields.io/github/v/release/golang-templates/seed)](https://github.com/golang-templates/seed/releases)
 [![Go Reference](https://pkg.go.dev/badge/github.com/golang-templates/seed.svg)](https://pkg.go.dev/github.com/golang-templates/seed)
 [![go.mod](https://img.shields.io/github/go-mod/go-version/golang-templates/seed)](go.mod)
@@ -11,68 +11,60 @@
 
 ⭐ `Star` this repository if you find it valuable and worth maintaining.
 
-👁 `Watch` this repository to get notified about new releases, issues, etc.
-
-## Description
-
-This is a GitHub repository template for a Go application.
-You can use it:
-
-- to create a new repository with automation and environment setup,
-- as reference when improving automation for an existing repository.
-
-It includes:
-
-- continuous integration via [GitHub Actions](https://github.com/features/actions),
-- build automation via [Make](https://www.gnu.org/software/make),
-- dependency management using [Go Modules](https://github.com/golang/go/wiki/Modules),
-- code formatting using [gofumpt](https://github.com/mvdan/gofumpt),
-- linting with [golangci-lint](https://github.com/golangci/golangci-lint)
-  and [misspell](https://github.com/client9/misspell),
-- unit testing with
-  [race detector](https://blog.golang.org/race-detector),
-  code coverage [HTML report](https://blog.golang.org/cover)
-  and [Codecov report](https://codecov.io/),
-- releasing using [GoReleaser](https://github.com/goreleaser/goreleaser),
-- dependencies scanning and updating thanks to [Dependabot](https://dependabot.com),
-- security code analysis using [CodeQL Action](https://docs.github.com/en/github/finding-security-vulnerabilities-and-errors-in-your-code/about-code-scanning),
-- [Visual Studio Code](https://code.visualstudio.com) configuration with [Go](https://code.visualstudio.com/docs/languages/go) support.
-
-## Usage
-
-1. Sign up on [Codecov](https://codecov.io/) and configure
-   [Codecov GitHub Application](https://github.com/apps/codecov).
-1. Click the `Use this template` button (alt. clone or download this repository).
-1. Replace all occurrences of `golang-templates/seed` to `your_org/repo_name` in all files.
-1. Replace all occurrences of `seed` to `repo_name` in [Dockerfile](Dockerfile).
-1. Follow [these](https://docs.codecov.com/docs/adding-the-codecov-token#github-actions)
-   instructions to add the `CODECOV_TOKEN` GitHub Actions and Dependabot secret.
-1. Update the following files:
-   - [CHANGELOG.md](CHANGELOG.md)
-   - [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md)
-   - [LICENSE](LICENSE)
-   - [README.md](README.md)
+👁 `Watch` this repository to get notified about new releases, issues, etc. -->
 
-## Setup
+`twu` consumes the [OpenWeatherMap API](https://openweathermap.org/current) to provide weather information for a given city.
+
+It's built with Go and uses [HTMX](https://htmx.org/) to make the application interactive without writing _any_ JavaScript.
+
+## Quickstart
+
+* To run the application, execute the following commands:
+
+    ```bash
+    # run the application
+    go run main.go
+
+    # quit the application
+    Ctrl + C
+    ```
+
+* Once it's running, you can access the application at `http://localhost:8080`.
+* To build the application, execute the following commands:
 
-Below you can find sample instructions on how to set up the development environment.
-Of course, you can use other tools like [GoLand](https://www.jetbrains.com/go/),
-[Vim](https://github.com/fatih/vim-go), [Emacs](https://github.com/dominikh/go-mode.el).
-However, take notice that the Visual Studio Go extension is
-[officially supported](https://blog.golang.org/vscode-go) by the Go team.
+    ```bash
+    # build the application
+    go build -o ./build/twu .
+    ```
+
+* To run the built application, execute the following commands:
+
+    ```bash
+    # run the application
+    ./build/twu
+    ```
+
+* To run the tests, execute the following commands:
+
+    ```bash
+    # run the tests
+    go test ./...
+    ```
+
+## Setup
 
 1. Install [Go](https://golang.org/doc/install).
-1. Install [Visual Studio Code](https://code.visualstudio.com/).
-1. Install [Go extension](https://code.visualstudio.com/docs/languages/go).
-1. Clone and open this repository.
-1. `F1` -> `Go: Install/Update Tools` -> (select all) -> OK.
+2. Install [Visual Studio Code](https://code.visualstudio.com/).
+3. Install [Go extension](https://code.visualstudio.com/docs/languages/go).
+4. Clone and open this repository.
+5. `F1` -> `Go: Install/Update Tools` -> (select all) -> OK.
 
 ## Build
 
 ### Terminal
 
-- `make` - execute the build pipeline.
-- `make help` - print help for the [Make targets](Makefile).
+* `make`: execute the build pipeline.
+* `make help`: print help for the [Make targets](Makefile).
 
 ### Visual Studio Code
 
@@ -90,63 +82,15 @@ More info: [Go Wiki](https://github.com/golang/go/wiki/Modules#releasing-modules
 
 Notable files:
 
-- [.github/workflows](.github/workflows) - GitHub Actions workflows,
-- [.github/dependabot.yml](.github/dependabot.yml) - Dependabot configuration,
-- [.vscode](.vscode) - Visual Studio Code configuration files,
-- [.golangci.yml](.golangci.yml) - golangci-lint configuration,
-- [.goreleaser.yml](.goreleaser.yml) - GoReleaser configuration,
-- [Dockerfile](Dockerfile) - Dockerfile used by GoReleaser to create a container image,
-- [Makefile](Makefile) - Make targets used for development, [CI build](.github/workflows) and [.vscode/tasks.json](.vscode/tasks.json),
-- [go.mod](go.mod) - [Go module definition](https://github.com/golang/go/wiki/Modules#gomod),
-- [tools.go](tools.go) - [build tools](https://github.com/golang/go/wiki/Modules#how-can-i-track-tool-dependencies-for-a-module).
-
-## FAQ
-
-### Why Visual Studio Code editor configuration
-
-Developers that use Visual Studio Code can take advantage of the editor configuration.
-While others do not have to care about it.
-Setting configs for each repo is unnecessary time consuming.
-VS Code is the most popular Go editor ([survey](https://blog.golang.org/survey2019-results))
-and it is officially [supported by the Go team](https://blog.golang.org/vscode-go).
-
-You can always remove the [.vscode](.vscode) directory if it really does not help you.
-
-### Why GitHub Actions, not any other CI server
-
-GitHub Actions is out-of-the-box if you are already using GitHub.
-[Here](https://github.com/mvdan/github-actions-golang) you can learn how to use it for Go.
-
-However, changing to any other CI server should be very simple,
-because this repository has build logic and tooling installation in [Makefile](Makefile).
-
-### How can I build on Windows
-
-Install [tdm-gcc](https://jmeubank.github.io/tdm-gcc/)
-and copy `C:\TDM-GCC-64\bin\mingw32-make.exe`
-to `C:\TDM-GCC-64\bin\make.exe`.
-Alternatively, you may install [mingw-w64](http://mingw-w64.org/doku.php)
-and copy `mingw32-make.exe` accordingly.
-
-Take a look [here](https://github.com/docker-archive/toolbox/issues/673#issuecomment-355275054),
-if you have problems using Docker in Git Bash.
-
-You can also use [WSL (Windows Subsystem for Linux)](https://docs.microsoft.com/en-us/windows/wsl/install-win10)
-or develop inside a [Remote Container](https://code.visualstudio.com/docs/remote/containers).
-However, take into consideration that then you are not going to use "bare-metal" Windows.
-
-Consider using [goyek](https://github.com/goyek/goyek)
-for creating cross-platform build pipelines in Go.
-
-### How can I customize the release
-
-Take a look at GoReleaser [docs](https://goreleaser.com/customization/)
-as well as [its repo](https://github.com/goreleaser/goreleaser/)
-how it is dogfooding its functionality.
-You can use it to add deb/rpm/snap packages, Homebrew Tap, Scoop App Manifest etc.
-
-If you are developing a library and you like handcrafted changelog and release notes,
-you are free to remove any usage of GoReleaser.
+* [.github/workflows](.github/workflows) - GitHub Actions workflows,
+* [.github/dependabot.yml](.github/dependabot.yml) - Dependabot configuration,
+* [.vscode](.vscode) - Visual Studio Code configuration files,
+* [.golangci.yml](.golangci.yml) - golangci-lint configuration,
+* [.goreleaser.yml](.goreleaser.yml) - GoReleaser configuration,
+* [Dockerfile](Dockerfile) - Dockerfile used by GoReleaser to create a container image,
+* [Makefile](Makefile) - Make targets used for development, [CI build](.github/workflows) and [.vscode/tasks.json](.vscode/tasks.json),
+* [go.mod](go.mod) - [Go module definition](https://github.com/golang/go/wiki/Modules#gomod),
+* [tools.go](tools.go) - [build tools](https://github.com/golang/go/wiki/Modules#how-can-i-track-tool-dependencies-for-a-module).
 
 ## Contributing