Readme

Author: Eliaxie

Cargo.lock

@@ -1,10 +1,9 @@
 [package]
 name = "rust_template"
-version = "0.1.7"
+version = "0.1.0"
 edition = "2021"
 description = "Example of Rust GitHub template"
 repository = "https://github.com/runtime-machines/rust-template"
-license = "MIT OR Apache-2.0"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 

Cargo.toml

@@ -1,49 +1,64 @@
-# Title of the projects
+# Rust Repository Template
 
 [![CI](https://github.com/runtime-machines/rust-template/workflows/CI/badge.svg)](https://github.com/runtime-machines/rust-template/actions)
-[![codecov](https://codecov.io/github/runtime-machines/rust-template/branch/main/graph/badge.svg?token=ROR5OUTHJ5)](https://codecov.io/github/runtime-machines/rust-template)
 
-## Description and scope of the project
-
-Use this repository as a production ready starting point for developing bug-free, well formatted, rust projects :)
-
-### What does this repository do:
-
-Workflows:
-
-- CI Workflows: 
-  - Test
-  - Format check
-  - Clippy
-  - Docs
-  - Publish
-  - Code coverage report on PR
-
-- CD Workflows: \
-  Release artifacts on Cargo and Github for:
-  - os: macos-latest
-    target: x86_64-apple-darwin
-  - os: ubuntu-latest
-    target: x86_64-unknown-linux-gnu
-  - os: windows-latest
-    target: x86_64-pc-windows-msvc
-  - os: ubuntu-latest
-    target: aarch64-unknown-linux-gnu
-  - os: ubuntu-latest
-    target: i686-unknown-linux-gnu
-
-- Security:
-  - Audit everyday at 00.00 UTC
-  - dependabot to update dependencies weekly
-
-Templates:
-- Issue Templates
-- Pull Request Template
-
-## Installation
-
-Click the "Use this template" button in the repo mainpage\
-Change "rust-template" with your repository name everywhere
+⭐ `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 repoisitory 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)
+  - CI Workflows: 
+    - Test
+    - Format check
+    - Clippy
+    - Docs
+    - Publish
+    - Code coverage report on PR
+  - CD Workflows (Release artifacts on Cargo and Github):
+    - os: macos-latest
+      target: x86_64-apple-darwin
+    - os: ubuntu-latest
+      target: x86_64-unknown-linux-gnu
+    - os: windows-latest
+      target: x86_64-pc-windows-msvc
+    - os: ubuntu-latest
+      target: aarch64-unknown-linux-gnu
+    - os: ubuntu-latest
+      target: i686-unknown-linux-gnu
+  - Security:
+    - Audit everyday at 00.00 UTC
+    - dependabot to update dependencies weekly
+- build automation via [Cargo](https://doc.rust-lang.org/cargo/commands/cargo-build.html),
+- dependency management using [Cargo Modules](https://doc.rust-lang.org/book/ch07-00-managing-growing-projects-with-packages-crates-and-modules.html),
+- code formatting using [rust fmt](https://rust-lang.github.io/rustfmt/),
+- linting with [clippy](https://github.com/rust-lang/rust-clippy),
+- code coverage [HTML report](https://docs.codecov.com/docs) and tests
+- releasing using [Github Release](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository) and [Cargo publish](https://doc.rust-lang.org/cargo/commands/cargo-publish.html),
+- dependencies scanning and updating thanks to [Dependabot](https://dependabot.com),
+- security code analysis using [Audit-check](https://github.com/actions-rs/audit-check),
+
+
+## Usage
+
+1. Sign up on [Codecov](https://codecov.io/) and configure
+   [Codecov GitHub Application](https://github.com/apps/codecov) for all repositories.
+1. Click the `Use this template` button (alt. clone or download this repository).
+1. Replace all occurrences of `runtime-machines/rust-template` to `your_org/repo_name` in all files.
+1. Update the following files:
+   - [CHANGELOG.md](CHANGELOG.md)
+   - [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md)
+   - [LICENSE](LICENSE) (when defined)
+   - [README.md](README.md)
 
 ## License