aboutsummaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authorAndrewRademacher <andrewrademacher@gmail.com>2016-02-28 14:38:16 -0600
committerAndrewRademacher <andrewrademacher@gmail.com>2016-02-28 14:38:16 -0600
commitd9a5d441ca9b5ae766311702557bf9f1ff0255b1 (patch)
tree3ef695c2ec24e5a53167d726a6af626778a4809a /README.md
parentf82a8dfc7e9b79ca6b88235d7297252adbb6d364 (diff)
downloadhaskell-graylog-d9a5d441ca9b5ae766311702557bf9f1ff0255b1.tar.gz
haskell-graylog-d9a5d441ca9b5ae766311702557bf9f1ff0255b1.tar.zst
haskell-graylog-d9a5d441ca9b5ae766311702557bf9f1ff0255b1.zip
Added readme, license, and light commenting.
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..94fefbe
--- /dev/null
+++ b/README.md
@@ -0,0 +1,16 @@
1# Graylog
2This library provides support for sending GELF formatted messages to Graylog.
3Currently the UDP chunked method is the only method supported.
4
5```haskell
6import Graylog.UDP
7
8main :: IO ()
9main = do
10 eglog <- openGraylog "192.168.99.100" "12201" defaultChunkSize
11 case eglog of
12 Left e -> assertFailure e
13 Right g -> sendLog g sample >> closeGraylog g
14 where
15 sample = simpleGelf "localhost" "hello world!"
16```