Skip to content

Commit

Permalink
Made README Topkg compatible
Browse files Browse the repository at this point in the history
  • Loading branch information
verbosemode committed Oct 29, 2016
1 parent 37d0acf commit 55483bb
Showing 1 changed file with 9 additions and 4 deletions.
13 changes: 9 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,14 @@
## Syslog Message
## syslog-message - Syslog message parser

%%VERSION%%

This is a parser for [RFC 3164](https://tools.ietf.org/html/rfc3164) Syslog messages.
This is a library for parsing and generating RFC 3164 compatible Syslog messages.

## Documentation

[![Build Status](https://travis-ci.org/verbosemode/syslog-message.svg?branch=master)](https://travis-ci.org/verbosemode/syslog-message)

[![docs](https://img.shields.io/badge/doc-online-blue.svg)](https://verbosemode.github.io/syslog-message/doc/) [![Build Status](https://travis-ci.org/verbosemode/syslog-message.svg?branch=master)](https://travis-ci.org/verbosemode/syslog-message)
[API documentation](https://verbosemode.github.io/syslog-message/doc/) is available online.

```ocaml
match Ptime.of_date_time ((1970, 1, 1), ((0, 0, 0), 0)) with
Expand All @@ -14,7 +19,7 @@ Some {Syslog_message.facility = Syslog_message.Local0; severity = Syslog_message
hostname = "server001"; message = "foobar"}
```

## Building
## Installation

This library can be installed with `opam`: `opam install syslog-message`

Expand Down

0 comments on commit 55483bb

Please sign in to comment.