Update the doc

dastoori · Jan 29, 2022 · f324837 · f324837
1 parent b36b569
commit f324837
Showing 1 changed file with 2 additions and 21 deletions.
diff --git a/doc.go b/doc.go
@@ -1,23 +1,4 @@
-// Package higgs is a tiny cross-platform Go library to hide or unhide files and directories
+// higgs is a tiny cross-platform Go library to hide or unhide files and directories
 //
-// 	package main
-//
-// 	import (
-// 		"fmt"
-// 		"github.com/dastoori/higgs"
-// 	)
-//
-// 	func main() {
-// 		err := higgs.Hide("foo.txt")
-//
-// 		if err != nil {
-// 			fmt.Println(err)
-// 		}
-//
-// 		err = higgs.Unhide("foo.txt")
-//
-// 		if err != nil {
-// 			fmt.Println(err)
-// 		}
-// 	}
+// **Supported OSs:** All unix based OSs (Tested on Ubuntu, MacOS), Windows
 package higgs