fix: doxumentation

README.md

@@ -7,22 +7,22 @@
 
 This tool has two features:
 
-- display the **status** of multiple git repos side by side
-- delegate **shell** commands on multiple git repos
+- display the [**status**](#1-gitas-status) of multiple git repos side by side
+- delegate [**shell**](#2-gitas-shell) commands on multiple git repos
 
 Unlike [gita](https://github.com/nosarthur/gita), it does not require maintenance of repositiories' list. It works on all repos found recursively in the given path.
 
 Additionally, issuing `gitas status` command with `-q` flag makes gitas query the remote for sync status. This reveals the need for `git fetch`. _This flag requires network connection and may be time consuming._
 
-## gitas status
+## 1. gitas status
 
 Show status of each git repository found in PATH
 
 ```bash
 gitas status [PATH] [flags]
 ```
 
-### Examples
+### 1.1. Examples
 
 ![Alt text](samples/Screenshot_status.png)
 
@@ -34,7 +34,7 @@ gitas status /home --time=false
 
 See also [markdown](samples/markdown_example.md) and [json](samples/json_example.json) example results.
 
-### Flags
+### 1.2. Flags
 
 ```text
   -n, --name {u|p|s}   name shown: unique|path|short (default u)
@@ -52,21 +52,21 @@ See also [markdown](samples/markdown_example.md) and [json](samples/json_example
   -h, --help           help for status
 ```
 
-### Flags inherited from parent commands
+### 1.3. Flags inherited from parent commands
 
 ```text
       --logging int   logging level [0...3] (default 0)
 ```
 
-## gitas shell
+## 2. gitas shell
 
 Execute "command" for each git repository found in PATH
 
 ```bash
 gitas shell [PATH] "command" [flags]
 ```
 
-### Examples
+### 2.1. Examples
 
 ![Alt text](samples/Screenshot_shell.png)
 
@@ -76,32 +76,34 @@ gitas shell ~ "git describe --abbrev=0 --tags"
 gitas shell "ls | grep 'P'"
 ```
 
-### Flags
+### 2.2. Flags
 
 ```text
   -h, --help   help for shell
 ```
 
-### Flags inherited from parent commands
+### 2.3. Flags inherited from parent commands
 
 ```text
       --logging int   logging level [0...3] (default 0)
 ```
 
-## Build
+## 3. Build
 
 ```bash
 goreleaser build --clean
 ```
 
-## License
+For more information check [BUILD.md](BUILD.md)
+
+## 4. License
 
 `gitas` was created by Lukasz Lobocki. It is licensed under the terms of the CC0 v1.0 Universal license.
 
 Inspired by [gita](https://github.com/nosarthur/gita).
 
 All components used retain their original licenses.
 
-## Credits
+## 5. Credits
 
 `gitas` was created with [cookiecutter](https://cookiecutter.readthedocs.io/en/latest/) and [template](https://github.com/lukasz-lobocki/go-cookiecutter).