From 4805f72c39f40d1889f472a50f973b7e21480d1d Mon Sep 17 00:00:00 2001
From: devopstaku <devopstaku@gmail.com>
Date: Wed, 9 Sep 2015 21:55:50 +0800
Subject: [PATCH] Add description about how to connect to local syslog with
 syslog hook

---
 README.md              |  2 +-
 hooks/syslog/README.md | 19 +++++++++++++++++++
 2 files changed, 20 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 6fa6e2062..2a9d3681d 100644
--- a/README.md
+++ b/README.md
@@ -198,7 +198,7 @@ func init() {
   }
 }
 ```
-
+Note: Syslog hook also support connecting to local syslog (Ex. "/dev/log" or "/var/run/syslog" or "/var/run/log"). For the detail, please check the [syslog hook README](hooks/syslog/README.md).
 
 | Hook  | Description |
 | ----- | ----------- |
diff --git a/hooks/syslog/README.md b/hooks/syslog/README.md
index 4dbb8e729..066704b37 100644
--- a/hooks/syslog/README.md
+++ b/hooks/syslog/README.md
@@ -18,3 +18,22 @@ func main() {
   }
 }
 ```
+
+If you want to connect to local syslog (Ex. "/dev/log" or "/var/run/syslog" or "/var/run/log"). Just assign empty string to the first two parameters of `NewSyslogHook`. It should look like the following.
+
+```go
+import (
+  "log/syslog"
+  "github.com/Sirupsen/logrus"
+  logrus_syslog "github.com/Sirupsen/logrus/hooks/syslog"
+)
+
+func main() {
+  log       := logrus.New()
+  hook, err := logrus_syslog.NewSyslogHook("", "", syslog.LOG_INFO, "")
+
+  if err == nil {
+    log.Hooks.Add(hook)
+  }
+}
+```
\ No newline at end of file