Add README and LICENSE

Author: opcoder0

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 opcoder0
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,50 @@
+# Fanotify Library
+
+Fanotify library for Go provides a simple API to monitor filesystem for specific events. The library attempts to simplify specifying events/actions to the watcher by providing valid flag combinations. The flag features are validated against the user's kernel version.
+
+Many of the useful features provided by [fanotify](https://man7.org/linux/man-pages/man7/fanotify.7.html) are available from Linux kernel 5.1 onwards. Most of the useful features availabe through this library work best on kernels 5.1 or later.
+
+## Example: Listener watching for file/directory accessed events
+
+```
+package main
+
+import (
+        "flag"
+        "fmt"
+        "os"
+
+        "github.com/opcoder0/fanotify"
+)
+
+func main() {
+        var listenPath string
+
+        flag.StringVar(&listenPath, "listen-path", "", "path to watch events")
+        flag.Parse()
+
+        if listenPath == "" {
+                fmt.Println("missing listen path")
+                os.Exit(1)
+        }
+        mountPoint := "/"
+        listener, err := fanotify.NewListener(mountPoint, 4096, true)
+        if err != nil {
+                fmt.Println(err)
+                os.Exit(1)
+        }
+        fmt.Println("Listening to events for:", listenPath)
+        listener.AddWatch(listenPath, fanotify.FileOrDirectoryAccessed)
+        go listener.Start()
+        i := 1
+        for event := range listener.Events {
+                fmt.Println(event)
+                if i == 5 {
+                        fmt.Println("Enough events. Stopping...")
+                        listener.Stop()
+                        break
+                }
+                i++
+        }
+}
+```