docs(readme): refactor readme according to v3 changes

Author: Rodrigo Navarro

Readme.md

@@ -1,97 +1,94 @@
-# CMF Commit Message Formatter - V2
+# CMF Commit Message Formatter - V3
 
-CMF is a simple to use utility to standarize commit messages on projects.
+CMF is a simple-to-use utility to standarized commit messages on projects.
 
-## Getting started
+## Migrating from V2
 
-Install via npm, just do `$ npm install -g go-cmf`
+- Installation via npm command is now deprecated and no longer maintained on **V3**.
+- You can still be using your `.cmf.yaml` file. Now you can extend this file with new attributes.
 
-Or from Go `go install github.com/walmartdigital/commit-message-formatter`
+## Major changes
 
-Once installed, go to your project an run `$ cmf init` and select one of the flows, it will create a `.cmf.yaml`file on your project with your selected flow.
+- .cmf.yaml file is no longer required if you want to use a simple flow.
+- The default flow of v3 is now strongly forced to use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/).
+- CMF binary is renamed to git-cmf, so now you can use it directly from git as `git cmf` command.
+- CMF is now available from Homebrew.
+- `cmf init` is cleaner now, it just creates a .cmf.yaml file with 
+a simple flow to let you customize as you want.
 
-## Flows
+## Getting Started
 
-CMF have three flows (for now) default, Jira and custom
+### Install CMF
 
-### Default
+- Using go install: `go install github.com/walmartdigital/commit-message-formatter`
+- Using Brew:
+  - `brew tap /walmartdigital/homebrew-git-cmf`
+  - `brew install homebrew-git-cmf`
+- Download binaries from Github
 
-Running `$ cmf init` and select default, you will get the default flow and prompted for:
+### Initialize project (optional)
 
-    - Type of change you made to your code
-    - Module affected by this change
-    - Commit message or description of your change
+If you want to customize your flow, you can run `git cmf init`,
+this command will create a .cmf.yaml file with the default flow.
 
-### Jira
+Then you can change the flow as you want.
 
-Running `$ cmf init` and select Jira, you will get the jira flow, this time you will be prompt for:
+### Variables
 
-    - Jira task ID
-    - Type of change you made to your code
-    - Commit message or description of your change
-
-### Custom
-
-Running `$ cmf init`and select custom, you will get the custom flow, this time it will create a `.cmf.yaml`file with default flow but with annotations of how change it.
-
----
-
-## Variables
-
-CMF have inner variables and you can access it throw templates using `{{}}`:
+CMF has inner variables and you can access it throw templates using `{{}}`:
 
 - {{BRANCH_NAME}} it will print the current branch name of your repository
 
-## Configurations
+Additionally, you can include external environment variables using the **ENV** 
+block described on the template.
 
-It is possible to config CMF as you like, you can change **custom flows, templates or assign default flows**. You can do this using a local file on the root of your porject or setting as global preferences with a file on your Home directory called `.cmf.yaml`.
+### Extending
 
-### TEMPLATE
+It is possible to config CMF as you like, you can change
+ **custom flows, templates, or assign default flows**. You can do this using 
+ a local file on the root of your project or set as global 
+ preferences with a file on your Home directory called `.cmf.yaml`.
 
-Set a template string for commit messages.
+### Template Structure
 
-#### Default flow
+A `.cmf.yaml` file is composite by 3 main blocks:
+  - ENV
+  - PROMPT
+  - TEMPLATE
 
-Default template `{{CHANGE}}({{MODULE}}): {{MESSAGE}}`. You can use this variables:
+#### ENV
 
-- CHANGE _type of change: feature, fix, update_
-- MODULE _module affected_
-- MESSAGE _commit message_
+It is a list of environment variables names, that later are mappings to be 
+accessible from other blocks.
 
 ```
-TEMPLATE: "{{CHANGE}}({{MODULE}}): {{MESSAGE}}"
+ENV:
+  - ENVIRONMENT_1
+  - ENVIRONMENT_2
+  ...
+  - ENVIRONMENT_10
 ```
 
-#### Jira flow
-
-Default template `{{JIRA-TASK}} ({{CHANGE}}): {{MESSAGE}}`. You can use this variables:
+#### PROMPT
 
-- JIRA*TASK \_jira task id, by default {{BRANCH_NAME}}*
-- CHANGE _type of change: feature, fix, update_
-- MESSAGE _commit message_
+Describe an input flow.
 
-```
-TEMPLATE: "{{JIRA-TASK}} ({{CHANGE}}): {{MESSAGE}}"
-```
+You can create your custom flows using this configuration attribute.` 
+Every `KEY` attribute is mapping as  a variable within the flow.
 
-### PROMPT
-
-You can create your custom flows using this configuration attribute.
-
-Prompt accept two types of prompts:
+Prompt accepts two kinds of questions:
 
 - Single question:
   - KEY _variable name_
   - LABEL _prompt title_
-- Select:
+
+- Select question:
   - KEY _variable name_
   - LABEL _prompt title_
   - OPTIONS _list of options_
     - VALUE _variable value_
     - DESC _variable description_
 
-_default .cmf.yaml sample file_
-
 ```
 PROMPT:
   - KEY: "CHANGE"
@@ -116,13 +113,20 @@ PROMPT:
 TEMPLATE: "{{CHANGE}}({{MODULE}}): {{MESSAGE}}"
 ```
 
+#### TEMPLATE
+
+Defines the way the commit message will be formatted using variables described on .cmf.yaml file.
+
+```
+TEMPLATE: "{{CHANGE}}({{MODULE}}): {{MESSAGE}}"
+```
 ---
 
 ## Contributions
 
 Use GitHub issues for requests.
 
-I actively welcome pull requests; learn how to contribute.
+I actively welcome pull requests; learn how to [contribute](CONTRIBUTING.md).
 
 ---