Merge pull request #44 from ivanilves/BUMP

docs: Refresh README and references

.github/workflows/ci.yml

@@ -55,7 +55,7 @@ jobs:
     - uses: actions/checkout@v3
 
     - name: staticcheck
-      uses: dominikh/staticcheck-action@v1.2.0
+      uses: dominikh/staticcheck-action@v1.3.0
 
     - name: golangci-lint
       uses: golangci/golangci-lint-action@v3

.goreleaser.yml

@@ -19,7 +19,7 @@ builds:
 brews:
 - name: travelgrunt
   homepage: 'https://github.com/ivanilves/travelgrunt'
-  description: 'Travel Terragrunt directory tree as a first class passenger!'
+  description: 'cd inside [mono]repos without fatigue!'
   folder: Formula
   tap:
     owner: ivanilves

README.md

@@ -15,7 +15,7 @@ Travel **[Terragrunt](https://terragrunt.gruntwork.io/)**, **[Terraform](https:/
 * use arrow keys to navigate the list and `/` key to search for specific items;
 
 ## Configuration
-If no configuration file found `travelgrunt` will assume repository having only Terragrunt projects inside!
+:bulb: If no configuration file found `travelgrunt` will assume repository having only Terragrunt projects inside.
 
 Create `.travelgrunt.yml` file in the root path of your repository. Example config for a random monorepo:
 
@@ -34,11 +34,11 @@ rules:
 :arrow_up: Config is essentially a list of sequentially applied path matching rules. Each rule can have these fields:
 
 * `prefix` - literal prefix to be matched against relative directory path;
-* `name` - a free form regular expression or a simple glob (`name: '*.go'`) match applied to file name;
-* `mode` - any matching behavior backed by a function from the [`mode`](https://github.com/ivanilves/travelgrunt/tree/main/pkg/config/mode) package;
-* `negate` - boolean directive that reverses the meaning of the match;
+* `name` - a free form regular expression or a simple glob (`name: '*.go'`) match applied to the file name;
+* `mode` - any matching behavior backed by a [custom logic] function from the [`mode`](https://github.com/ivanilves/travelgrunt/tree/main/pkg/config/mode) package;
+* `negate` - boolean directive that reverses the meaning of the match, excluding the paths matched;
 
-:bulb: Even while developing `travelgrunt` itself I use it to navigate [package directories](https://github.com/ivanilves/travelgrunt/blob/main/.travelgrunt.yml) of the application.
+:bulb: Even while developing `travelgrunt` itself we use it to navigate [package directories](https://github.com/ivanilves/travelgrunt/blob/main/.travelgrunt.yml) of the application :tophat:
 
 ## Shell aliases
 
@@ -48,6 +48,8 @@ alias tg='_tg(){ travelgrunt -out-file ~/.tg-path ${@} && cd "$(cat ~/.tg-path)"
 alias tt='_tt(){ travelgrunt -top -out-file ~/.tg-path && cd "$(cat ~/.tg-path)" }; _tt'
 ```
 
+These lines are usually added to `~/.bashrc` or `~/.zshrc` file, depending on your system and shell of choice.
+
 :bulb: **tt** is a "convenience alias" that brings you to the top level path of your repository.
 
 ### Why aliases?

cmd/travelgrunt/main.go

@@ -98,7 +98,7 @@ func main() {
 	entries, paths, err := directory.Collect(rootPath, cfg)
 
 	if err != nil {
-		log.Fatalf("failed to collect Terragrunt project directories: %s", err.Error())
+		log.Fatalf("failed to collect directories: %s", err.Error())
 	}
 
 	if err := filter.Validate(flag.Args()); err != nil {

pkg/menu/menu.go

@@ -27,7 +27,7 @@ func getSize(itemCount int, size int) int {
 	return size
 }
 
-// Build creates an interactive menu to chose Terragrunt project from
+// Build creates an interactive menu to chose destination directory from
 func Build(items []string, maxSize int, previous string) (selected string, err error) {
 	if len(items) == 0 {
 		return "", fmt.Errorf("no items")