summaryrefslogtreecommitdiff
path: root/lib/opusfile/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'lib/opusfile/README.md')
-rw-r--r--lib/opusfile/README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/lib/opusfile/README.md b/lib/opusfile/README.md
new file mode 100644
index 00000000..609cc6b9
--- /dev/null
+++ b/lib/opusfile/README.md
@@ -0,0 +1,18 @@
+# Opusfile
+
+[![GitLab Pipeline Status](https://gitlab.xiph.org/xiph/opusfile/badges/master/pipeline.svg)](https://gitlab.xiph.org/xiph/opusfile/commits/master)
+[![Travis Build Status](https://travis-ci.org/xiph/opusfile.svg?branch=master)](https://travis-ci.org/xiph/opusfile)
+[![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/github/xiph/opusfile?branch=master&svg=true)](https://ci.appveyor.com/project/rillian/opusfile)
+
+The opusfile and opusurl libraries provide a high-level API for
+decoding and seeking within .opus files on disk or over http(s).
+
+opusfile depends on libopus and libogg.
+opusurl depends on opusfile and openssl.
+
+The library is functional, but there are likely issues
+we didn't find in our own testing. Please give feedback
+in #opus on irc.freenode.net or at opus@xiph.org.
+
+Programming documentation is available in tree and online at
+https://opus-codec.org/docs/