feat (lib): add documentation to Install command

automation-co · Jul 28, 2022 · 4c6db43 · 4c6db43
1 parent 4a5fced
commit 4c6db43
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/internal/lib/install.go b/internal/lib/install.go
@@ -7,6 +7,8 @@ import (
 	"path/filepath"
 )
 
+// Install command will iterate the files from .husky/hooks create the hardlinks into .git/hooks and chmod to 0755 permission.
+// The function intend to fail in case .git or .husky directory doesn't exist.
 func Install() error {
 	fmt.Println("Installing hooks")