summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorChristian Pointner <equinox@spreadspace.org>2016-01-05 23:43:01 (GMT)
committerChristian Pointner <equinox@spreadspace.org>2016-01-05 23:43:01 (GMT)
commit39efde5312458a10c32d2ee816bad827ba9efc86 (patch)
treecca75d56fbd1db966f329831da489968a087e508 /README.md
initial commit
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7ddd5b6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,18 @@
+# The Radio Helsinki Rivendell Go Package
+
+This golang package contains a set of tools and bindings to the rivendell
+database. It can be used for various tasks in the Radio Helsinki Deployment
+of Rivendell.
+
+## Status
+
+This is currently on development. Any api calls are subject to change!
+
+## API
+
+[![GoDoc](https://godoc.org/helsinki.at/rhrd-go?status.svg)](https://godoc.org/helsinki.at/rhrd-go)
+[Source code.](https://git.helsinki.at/?p=rhrd-go.git;a=summary)
+
+## Licence
+
+ © 2016 Christian Pointner <equinox@spreadspace.org> GPL-3+