1 files changed, 14 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..16d1ea0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,14 @@
+# library for DNS encapsulations and transporting of them
+
+[![Build Status](https://travis-ci.com/DNS-OARC/dnswire.svg?branch=develop)](https://travis-ci.com/DNS-OARC/dnswire) [![Total alerts](https://img.shields.io/lgtm/alerts/g/DNS-OARC/dnswire.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/DNS-OARC/dnswire/alerts/) [![Bugs](https://sonarcloud.io/api/project_badges/measure?project=dns-oarc%3Adnswire&metric=bugs)](https://sonarcloud.io/dashboard?id=dns-oarc%3Adnswire) [![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=dns-oarc%3Adnswire&metric=security_rating)](https://sonarcloud.io/dashboard?id=dns-oarc%3Adnswire)
+
+**Currently Work in Progress!**
+
+A C library for encoding/decoding different DNS encapsulations and
+transporting them over different protocols.
+
+Supported encapsulations:
+- [DNSTAP](http://dnstap.info) using Protobuf
+
+Currently supports:
+- Frame Streams using [tinyframe](https://github.com/DNS-OARC/tinyframe)