all: documentation

golang-design · Dec 11, 2019 · 9d8234c · 9d8234c
1 parent 3a8e6bf
commit 9d8234c
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -1,3 +1,13 @@
 # mkill
 
-mkill limites the number of threads in a Go program
+mkill limits the number of threads in a Go program
+
+## Usage
+
+```
+mkill.GOMAXTHREADS(50)
+```
+
+## License
+
+MIT &copy; Changkun Ou
diff --git a/mkill.go b/mkill.go
@@ -15,7 +15,7 @@ var (
 	pid       = os.Getpid()
 	maxThread = int32(runtime.NumCPU())
 	interval  = time.Second
-	debug     = true
+	debug     = false
 )
 
 func checkwork() {
@@ -57,7 +57,7 @@ func init() {
 	}()
 }
 
-// GOMAXTHREADS change the limites of the maximum threads in runtime
+// GOMAXTHREADS change the limits of the maximum threads in runtime
 // and returns the previous number of threads limit
 func GOMAXTHREADS(n int) int {
 	return int(atomic.SwapInt32(&maxThread, int32(n)))