docs: refactoring README to more friendly

Author: dd84ai

README.md

@@ -1,253 +1,52 @@
+# Autogit
+
 <p align="center">
-  <img src="assets/logo.png" />
+  <img src="assets/logo.png" style="width: 200px; height: 200px;"/>
 </p>
 
-## 🎯 Goals
+**Communicating through git professionally**
+
+autogit is a CLI tool to validate submitted commits according to [git conventional commits standard](https://www.conventionalcommits.org/en/v1.0.0/). the tool allows to generate changelogs for releases in different formats. When you generate changelogs and see quick feedback of an end result, it promotes you to write commits better.
+
+as a result of a tool work, you communicate your developer work better to other developers and have more professional looking repository.
+
+# Features
+
+- hooks to git-hooks and works to validate your git commits to git conventional commits standard for any git tool.
+  - has extra possible validating rules to configure, like having minimum 3 words in a subject of a commit.
+  - `autogit hook activate --global`(flag to turn it on for all repos)
+- suggests next [semantic version](https://semver.org/) with `autogit semver`
+  - has options to sugest next version as alpha, beta, prerelease version with build meta data.
+- generates changelogs with `autogit changelog` command
+  - currently supports markdown and bbcode formats
+  - has option `--validate` to run validation of commits (for CI usage)
+- easy create and push of a git tag with autoinserted changelog through `autogit semver --tag --push`
+- CI friendly, not requires any dependencies for its usage for everything (inbuilt git-go to access git information)
+
+# Example
+
+text version at ubuntu 22.04:
+- `apt update && apt install -y curl` (install curl if not installed)
+- install latest
+
+# Installation
+
+## Linux
+
+### Install latest
+
+- install curl if not present
+- install with `rm /usr/local/bin/autogit ; curl -L $(curl -Ls -o /dev/null -w %{url_effective} https://github.com/darklab8/darklab_autogit/releases/latest | sed "s/releases\/tag/releases\/download/")/autogit-linux-amd64 -o /usr/local/bin/autogit && chmod 777 /usr/local/bin/autogit`
 
-- CI friendly tool for automatic following of [Git Conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) rules (standard for more descriptive commits)
-- The tool generates automatically changelogs of new features and bug fixes for your product releases
-- and also calculates next [semantic version](https://semver.org/) your next product release should be having
+- check installation with `autogit version` command. Expect to see `OK autogit version: v{version}`
 
-Essentially tool... To decrease toll on release documentation writing, and to start writing more descriptive commits \
-It will help to make your repository looking like more professional in terms of commits, tags, versions, releases and changelogs. \
-With ability to see quickly how your changelog looks like, it will motivate you to write more meaningful commits
+### install specific version
 
-## 🌟 Features
+- install with `rm /usr/local/bin/autogit ; curl -L https://github.com/darklab8/darklab_autogit/releases/download/v2.1.0/autogit-linux-amd64 -o /usr/local/bin/autogit && chmod 777 /usr/local/bin/autogit`
+- See other installations at {INSERT LINK TO OTHER INSTALLATIONS}
 
-- [git conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) validations (and optional other ones) on pre-commit hook
-- validation of your commit history on `autogit changelog --validate` request
-- automatic next [semantic versioning](https://semver.org/spec/v2.0.0.html) calculation for your product release. `autogit semver`
-  - creating and pushing tag on `autogit semver --tag --push`. Changelog is automatically auto inserted into this tag.
-- auto generating [changelogs](https://github.com/darklab8/darklab_autogit/releases/tag/v0.3.0-rc.2) new features and bug fixes for your next product release
-- CI friendly binary file for any OS and arhictecture. Development with CI in mind. [CI examples](https://github.com/darklab8/darklab_autogit/tree/master/.github/workflows). Compiled for:
-  - linux-amd64
-  - linux-arm64
-  - linux-386
-  - linux-arm
-  - windows-amd64
-  - windows-386.exe
-  - windows-arm64.exe
-  - windows-arm.exe
-  - macos-amd64
-  - macos-arm64
-- Contains inbuilt git. Not requiring git to be installed for its functionality
+## Contacts
 
-## 🤙 Support:
-
-##### First tier support - we will prioritize solving any issues. Unit tests run on every commit.
-
-- for linux and CI usage
-
-##### Second tier support - periodically checking it works in VM with Windows 10
-
-- for windows
-
-##### Third tier support - only compiled, and accepting bug fixes implemented by contributors
-
-- for macos
-
-## 🚀 Short opinionated installation
-
-assuming you have Linux:
-
-1) `curl -o /usr/local/bin/autogit https://github.com/darklab8/darklab_autogit/releases/download/v1.2.0/autogit-linux-amd64 && chmod 777 /usr/local/bin/autogit`
-2) `autogit semver` to verify installation and get next expected semantic version
-3) (Optional) config init
-
-   * `autogit init` to create `autogit.yml` config locally in repo.
-   * `autogit init --global` to make user global settings file fallback
-   * if u will do nothing, program will just fallback to using config from memory
-4) `autogit hook activate` to turn validation commit hooks on
-
-   * `autogit hook activate --global` will turn it on globally for all repos
-   * `autogit hook deactivate` (also with possible flag `--global`) can serve to deactivate this functionality
-
-## ✈️ Detailed installation
-
-1. [download latest stable release](https://github.com/darklab8/darklab_autogit/releases) and put to env PATH searchable range
-
-- Linux:
-
-  - Check your PATH bin serachable locations with `echo "$PATH"` and put into any of them or add new location, change settings to allow it being executable with `chmod`
-  - Recomendation to put into `/usr/local/bin`
-  - Linux ubuntu one liner: `curl -o /usr/local/bin/autogit https://github.com/darklab8/darklab_autogit/releases/download/v1.1.0/autogit-linux-amd64 && chmod 777 /usr/local/bin/autogit`
-- Windows:
-
-  - Check your PATH bin locations with `echo %PATH%` and put binary file any of them or add to new one, be sure to rename from like `autogit-windows-amd64.exe` to `autogit.exe`
-  - If u use `Git Bash`, recommendation to put into `~/bin` for usage in Git Bash only, or into `C:\Program Files\Git\cmd` for working in any terminal
-  - U can add to any other PATH bin searchable locations or add a new one
-- MacOS
-
-  - (To be written where to put)
-
-2. (Optional) init autogit.yml with `autogit init` command in the root of repository. change REPOSITORY_OWNER and REPOSITORY_NAME to yours
-   1. Or init global one, or don't init at all (see 3d step of short opinionated instructioon)
-3. run `autogit hook activate` to create `.git-hook` folder and enabling it in your git config for automated commit validation on pre-commit hook
-   1. Or activate globally with flag `--global`
-   2. `deactivate with `autogit hook deactivate`, using `--global` flag if necessary as well.
-
-P.S. Current repository runs on configured autogit as well
-
-## 🤾‍♂️ Usages
-
-### scenario #1 - validator / Git commit validation / Changelog validation
-
-You try to write git commit -m "feat: add rendering in format format"
-your githook is activated and tries to parse your commit name accroding to git conventional commits standard. If unable, it will give you error and prevent commit
-
-```mermaid
-flowchart TD
-  GitCommit[attempt to fixate commit like\ngit commit -m 'feat: add md rendering'\nwith 'autogit hook activate' enabled]
-  RequestValidatingChangelog[Request changelog with --validate flag] --> TryParsingCommitMessage
-  GitCommit --> TryParsingCommitMessage[Try parsing commit message\nto git conventional commit\ntype \ scope \ subject \ body \ footers]
-  TryParsingCommitMessage --> ReportFail[Reporting errors if unable]
-  TryParsingCommitMessage --> ContinuingValidation[Continue Validation]
-  ContinuingValidation --> CheckOptionalValidationRulesIfEnabled[Check options validation rules\nif they are enabled]
-  CheckOptionalValidationRulesIfEnabled --> CommitTypeInAllowedList[Commit type is\nin allowed list]
-  CommitTypeInAllowedList --> WhenAppliedRules
-  CheckOptionalValidationRulesIfEnabled --> CheckOtherEnabledRulesInSettings[Check other enabled\nrules in settings]
-  CheckOtherEnabledRulesInSettings --> WhenAppliedRules
-  CheckOptionalValidationRulesIfEnabled --> WhenAppliedRules[when applied rules]
-  WhenAppliedRules --> IfCommit[if it was commit,\nthen fixate if passed rules,\nor cancel fixation]
-  WhenAppliedRules --> IfChangelog[if it was changelog validation\nthen report no errors and exit code 0\nfor pipeline checks]
-```
-
-### scenario #2 - changelog / Your wish to see changelog of additions you made, what are new features, what are fixes. For user view
-
-You wish to have changelog auto generated.
-
-```mermaid
-flowchart TD
-    RequestingChangelog[Requesting changelog]
-    RequestingChangelog --> ChangelogFromLatestCommitToPreviousTagVersion
-    ChangelogFromLatestCommitToPreviousTagVersion[Requesting changelog from previous\ntag to latest commit]
-    RequestingChangelog --> ChangelogFromChosenTagToPreviousTag
-    ChangelogFromChosenTagToPreviousTag[Requesting changelog from chosen tag\nversion to previous tag version]
-    ChangelogFromLatestCommitToPreviousTagVersion --> GenerateChangelog
-    GenerateChangelog[Start generating changelog]
-    ParseCommits[Parse commit in necessary tag range]
-    ChangelogFromChosenTagToPreviousTag --> GenerateChangelog
-    GenerateChangelog --> ParseCommits
-    ParseCommits --> SelectAllowedTypesForRender
-    SelectAllowedTypesForRender[Filter conventional commit `types` like `feat` allowed for render]
-    SelectAllowedTypesForRender --> SubgroupIntoConventionalCommitScopes
-    SubgroupIntoConventionalCommitScopes[Sub group commits according to conventional commit `scope`]
-    GenerateChangelog --> CalculateNextSemver
-    CalculateNextSemver[Calculate Next Semantic Version]
-    CalculateNextSemver --> SendChangelogToRender
-    SubgroupIntoConventionalCommitScopes --> SendChangelogToRender
-    SendChangelogToRender[Receive changelog for render]
-    SendChangelogToRender --> RenderChangelogMarkdown
-    SendChangelogToRender --> RenderChangelogRst
-    SendChangelogToRender --> RenderChangelogHtml
-    RenderChangelogMarkdown[Render in markdown\n--implemented--]
-    RenderChangelogRst[Render in rst\n--not implemented--]
-    RenderChangelogHtml[Render in html\n--not implemented--]
-```
-
-###### example of rendered changelog
-
-[Full example of rendered changelog](https://github.com/darklab8/darklab_autogit/releases/tag/v0.3.0-rc.2)
-
-### Scenario #3 - nextSemVer / You wish to know which next semantic version / semantic tag should be applied to your release.
-
-Program checks if u made no commits, or only refactoring and styling.
-
-- If u made no changes, then next version is same as previous one.
-- If you made `fix`, then it increases PATCH version of semantic version. Your next version is `0.0.2` rendered
-- if you made `feat` request, then next MINOR version is increased. Your next version is `0.1.0`
-- if you made breaking changes, users should know `feat!` or `BREAKING CHANGE:`, then next version is `1.0.0`
-- if u had no previous versions, it will calculate new one as `0.0.0` + calculated version changes
-
-more detailed algorithm, accounting also prerelease version calculations:
-
-```mermaid
-flowchart TD
-  RequestNextSemanticVersioning[Request next semantic versioning]
-  RequestNextSemanticVersioning --> FindCommits[Find commits\nfrom HEAD^1 to previous stable semantic version like v0.3.0]
-  FindCommits --> CalculateVersionChange[Calculate main version change\nChoose only ONE path]
-  CalculateVersionChange --> MajorChange[if git conventional commits\nwith breaking changes\nlike feat! are present\nand it is not 0.*.* development mode\nor flag `--publish` is present,\nthen add MAJOR version\nand reset MINOR and PATCH to 0\nchange: +1.0.0]
-  CalculateVersionChange --> MinorChange[If commits with `feat` type are present\nincrease MINOR version\nand reset PATCH version\nto zero change: *.+1.0,]
-  CalculateVersionChange --> PatchChange[if only commits with `fix`\n are present\nthen change only PATCH\nchange: *.*.+1]
-  MajorChange --> CalculatedMainVersion
-  MinorChange --> CalculatedMainVersion
-  PatchChange --> CalculatedMainVersion
-  CalculatedMainVersion[Calculated main version]
-  CalculatedMainVersion --> CalculatePrereleaseVersion[Calculate next prerelease version]
-  CalculatePrereleaseVersion --> FindLatestPrerelease[Find latest alpha beta and rc versions\nwith scanning commits up to latest stable version\nExcept not counting latest commit\nChoose ONE, SEVERAL or ALL paths next:]
-  FindLatestPrerelease --> AlphaFlag[if alpha flag is present\nincrease alpha version\nand mark for rendering]
-  FindLatestPrerelease --> BetaFlag[if beta flag is present\nincrease beta version\nand mark for rendering]
-  FindLatestPrerelease --> RcFlag[if rc-release candidate-\nflag is present\nincrease rc version\nand mark for rendering]
-  AlphaFlag --> CombineIntoTotalPrereleaseVersion
-  BetaFlag --> CombineIntoTotalPrereleaseVersion
-  RcFlag --> CombineIntoTotalPrereleaseVersion
-  CombineIntoTotalPrereleaseVersion[Combine into latest prerelease version]
-  CalculatedMainVersion ----> AddBuildMetaData[Add build meta data\nas +$BuildMetaData\nto the end of version]
-  CombineIntoTotalPrereleaseVersion --> OutputFinalSemanticVersion
-  AddBuildMetaData --> OutputFinalSemanticVersion[Render Final Semantic Version]
-```
-
-### TLDR
-
-So in a nutshell, it takes away complexity of using git conventional commits and semantic versioning. You are auto guided and auto corrected how correctly to perform it xD
-u only need correctly writing meaning/subject/description to your commits 🙂 but since u see what is rendered to users, you quickly learn how to write it better
-Plus it was made in CI friendly way
-
-why semantic versioning is important, to read here https://semver.org/
-well, about git conventional commits is here: https://www.conventionalcommits.org/en/v1.0.0/
-
-as an example, all my releases of darktool were made with similar automatation.
-Changelogs and versions https://github.com/darklab8/darklab_freelancer_darktool/releases
-
-## ⚛️ Future development and resources for inspiration
-
-- https://www.quora.com/What-is-the-difference-between-alpha-beta-and-RC-software-version // Adding ability of beta versions
-- https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional // Configurable stricter rules to validator
-- https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#-commit-message-guidelines // Just more about git conventional commits
-- https://www.npmjs.com/package/git-conventional-commits
-- https://www.conventionalcommits.org/en/about/ tools
-- https://github.com/c4urself/bump2version/blob/master/RELATED.md // research alternatives
-- https://gist.github.com/qoomon/5dfcdf8eec66a051ecd85625518cfd13
-
-Discussions about future development and features in [Pull Requests](https://github.com/darklab8/darklab_autogit/issues)
-
-## 📇 Dev Requirements
-
-- golang
-  - wget https://go.dev/dl/go1.20.3.linux-amd64.tar.gz
-  - sudo rm -rf /usr/local/go && sudo tar -C /usr/local -xzf go1.20.3.linux-amd64.tar.gz
-  - export PATH=$PATH:/usr/local/go/bin
-- cobra generator https://github.com/spf13/cobra-cli/blob/main/README.md
-- cobra guide https://github.com/spf13/cobra/blob/main/user_guide.md
-- godoc
-- add binary discovery for cobra-cli, godoc detection
-  - `export PATH="$PATH:/usr/local/go/bin:$HOME/go/bin"`
-- install latest stable autogit 😄
-
-## 🏛️ Code architecture
-
-```mermaid
-flowchart TD
-  UI[Interface-CLI\nUser interface via Cobra CLI third party lib]
-  UI --> Actions[Actions\nreusable actions without\nattachements to UI details]
-  Actions --> SemanticGit[Semantic Git\nImplements main business logic of repository\nwith added logic of conventional commits\nAnd semantic versioning]
-  Actions --> Changelog[Changelog\nHow to generate one]
-  Actions --> Validator[Validator\nRules for optional validations]
-  Changelog --> SemanticGit
-  Validator --> SemanticGit
-  SemanticGit --> SemVer[SemVer\nimplements original Semantic Version\naccording to SemVer2.0.0 standard\nImplemented in current repo]
-  SemanticGit --> Git[Git\ngit wrapper to simple interface\nfor current repository logic\nimplemented in current repo]
-  Git --> GitGo[Git-Go\nEngine under the hood for\nGit repository operations\nImplemented by third party]
-```
-
-## 🤝 Contributions and contacts:
-
-- contact author [@dd84ai](https://github.com/dd84ai) at `dark.dreamflyer@gmail.com`
-- open [Pull Requests with bug fix or feat requests](https://github.com/darklab8/darklab_autogit/issues)
-- join [Darklab Discord server](https://discord.gg/aukHmTK82J)
-
-## ❓ FAQ
-
-- if u have strange bugs, consider as first actions
-  - updating to latest verion
-  - wiping previous present repository local and user global autogit.yml settings file :smile:
+- [@dd84ai](https://github.com/dd84ai) at `dark.dreamflyer@gmail.com`
+- open [Pull Requests with question](https://github.com/darklab8/darklab_autogit/issues)
+- [Darklab Discord server](https://discord.gg/aukHmTK82J)