Add readme

manen · Mar 2, 2021 · 71b5bf1 · 71b5bf1
1 parent 752fcc8
commit 71b5bf1
Showing 1 changed file with 39 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,39 @@
+# Cleaner
+
+Cleaner for Go
+
+## Installation
+
+```sh
+go get github.com/manen/cleaner
+```
+
+## Usage
+
+```go
+package main
+
+import (
+  "github.com/manen/cleaner"
+)
+
+func main() {
+  // Create a new cleaner
+  c := cleaner.Cleaner{
+    Name: "Example",
+    CleanUp: func() {
+      // Clean up
+    }
+  }
+
+  // Add the new cleaner
+  cleaner.AddCleaner(c)
+
+  // Run all the cleaners
+  cleaner.CleanUp()
+}
+```
+
+## License
+
+[GPL 3](LICENSE.txt)