feat(.github): switch to Codecov for code coverage (#222)

- feat(.github): switch code coverage tool to Codecov
- feat(README): add new sections, fix some lint errors with markdownlint

Author: ar3s3ru

.github/workflows/test.yml

@@ -28,8 +28,10 @@ jobs:
           go-version: '1.21'
       - name: Run go test
         run: make go.test
-      - name: Analyze with SonarCloud
-        uses: sonarsource/sonarcloud-github-action@v2.1
-        env:
-          GITHUB_TOKEN: ${{ github.token }}
-          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+      - name: Upload coverage report
+        uses: codecov/codecov-action@v4
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          files: ./coverage.txt
+          verbose: true
+          fail_ci_if_error: true

README.md

@@ -1,29 +1,21 @@
-<br />
+<!-- markdownlint-disable-file MD033 -->
+<!-- markdownlint-disable-file MD041 -->
 
+<br />
 <div align="center">
     <img alt="Eventually" src = "./resources/logo.png" width = 300>
 </div>
-
 <br />
-
 <div align="center">
     <strong>
-        Event Sourcing for Go
+        Domain-driven Design, Event Sourcing and CQRS for Go
     </strong>
 </div>
-
 <br />
-
 <div align="center">
-    <!-- Testing pipeline -->
-    <a href="https://github.com/get-eventually/go-eventually/actions?query=workflow%3A%22Main+Workflow%22">
-        <img alt="GitHub Workflow Status"
-        src="https://img.shields.io/github/actions/workflow/status/get-eventually/go-eventually/main.yml?branch=main&style=flat-square">
-    </a>
     <!-- Code Coverage -->
-    <a href="https://sonarcloud.io/project/activity?custom_metrics=coverage&graph=custom&id=get-eventually_go-eventually">
-        <img alt="Sonar Coverage"
-        src="https://img.shields.io/sonar/coverage/get-eventually_go-eventually?server=https%3A%2F%2Fsonarcloud.io&style=flat-square">
+    <a href="https://app.codecov.io/gh/get-eventually/go-eventually">
+        <img alt="Codecov" src="https://img.shields.io/codecov/c/github/get-eventually/go-eventually?style=flat-square">
     </a>
     <!-- pkg.go.dev -->
     <a href="https://pkg.go.dev/github.com/get-eventually/go-eventually">
@@ -36,38 +28,46 @@
         src="https://img.shields.io/github/license/get-eventually/go-eventually?style=flat-square">
     </a>
 </div>
-
 <br />
 
+> [!WARNING]
+> Though used in production environment, the library is still under active development.
 
-Idiomatic library to help you build Event Sourced application in Go.
+<!-- markdownlint false positive -->
 
-## Please note
+> [!NOTE]
+> Prior to `v1` release the following Semantic Versioning
+is being adopted:
+>
+> * Breaking changes are tagged with a new **minor** release,
+> * New features, patches and documentation are tagged with a new **patch** release.
 
-The library is currently under development, and not yet 100% ready for production use-cases.
+## Overview
 
-### Note on semantic versioning
+`eventually` is a library providing abstractions and components to help you:
 
-This library is **actively being developed**, and prior to `v1` release the following [Semantic versioning]()
-is being adopted:
+* Build Domain-driven Design-oriented code, (Domain Events, Aggregate Root, etc.)
 
-* Breaking changes are tagged with a new `MINOR` release
-* New features, patches and documentation are tagged with a new `PATCH` release
+* Reduce complexity of your code by providing ready-to-use components, such as PostgreSQL repository implementation, OpenTelemetry instrumentation, etc.
 
-## Contributing
+* Implement event-driven architectural patterns in your application, such as Event Sourcing or CQRS.
 
-You want to contribute to `eventually` but you don't know where to start?
+### How to install
 
-First of all, thank you for considering contributing :heart:
+You can add this library to your project by running:
+
+```sh
+go get -u github.com/get-eventually/go-eventually
+```
+
+## Contributing
 
-You can head over our [`CONTRIBUTING`](./CONTRIBUTING.md) section to know
-how to contribute to the project, and — in case you don't have a clear idea what
-to contribute — what is most needed needed from contributors.
+Thank you for your consideration ❤️ You can head over our [CONTRIBUTING](./CONTRIBUTING.md) page to get started.
 
 ## License
 
 This project is licensed under the [MIT license](LICENSE).
 
 ### Contribution
 
-Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in `get-eventually` by you, shall be licensed as MIT, without any additional terms or conditions.
+Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in `go-eventually` by you, shall be licensed as MIT, without any additional terms or conditions.

flake.nix

@@ -33,6 +33,7 @@
               # Linters
               nil
               golangci-lint
+              markdownlint-cli
             ];
 
             # Provide binary paths for tooling through environment variables.