From: Chris Howey <chris@howey.me>
Date: Tue, 22 May 2012 15:06:41 +0000 (-0500)
Subject: Convert README to markdown
X-Git-Tag: v1.7.2~425
X-Git-Url: https://go.fuhry.dev/?a=commitdiff_plain;h=91b771ae6b23d07ea00925e49a3c5a5df6d1f0e7;p=fsnotify.git

Convert README to markdown
---

diff --git a/README b/README
deleted file mode 100644
index e17d859..0000000
--- a/README
+++ /dev/null
@@ -1,33 +0,0 @@
-File system notifications for Go
-
-Cross platform, works on:
-Windows
-Linux
-BSD
-OSX
-
-Example:
-    watcher, err := fsnotify.NewWatcher()
-    if err != nil {
-        log.Fatal(err)
-    }
-
-    for {
-        select {
-        case ev := <-watcher.Event:
-            log.Println("event:", ev)
-        case err := <-watcher.Error:
-            log.Println("error:", err)
-        }
-    }
-
-    err = watcher.Watch("/tmp")
-    if err != nil {
-        log.Fatal(err)
-    }
-
-Notifications:
-IsCreate()
-IsDelete()
-IsModify()
-IsRename()
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5f08769
--- /dev/null
+++ b/README.md
@@ -0,0 +1,42 @@
+# File system notifications for Go
+
+Cross platform, works on:
+* Windows
+* Linux
+* BSD
+* OSX
+
+Example:
+```go
+    watcher, err := fsnotify.NewWatcher()
+    if err != nil {
+        log.Fatal(err)
+    }
+
+    // Process events
+    go func() {
+        for {
+            select {
+            case ev := <-watcher.Event:
+                log.Println("event:", ev)
+            case err := <-watcher.Error:
+                log.Println("error:", err)
+            }
+        }
+    }()
+
+    err = watcher.Watch("/tmp")
+    if err != nil {
+        log.Fatal(err)
+    }
+
+    /* ... do stuff ... */
+    watcher.Close()
+```
+
+For each event:
+* Name
+* IsCreate()
+* IsDelete()
+* IsModify()
+* IsRename()