ref: 51c5c36ed8efa43c520501065b0f16e66b7e12fc
parent: f4e0ed091f60ce7bacdd9f267ebea5e24e05cc7e
author: Ralph Giles <[email protected]>
date: Mon Jan 4 11:17:24 EST 2016
Merge the generic bits of the release notes into the readme. Also switch to markdown-style headings to the benefit of github.
--- a/README.txt
+++ b/README.txt
@@ -1,3 +1,14 @@
-== Opusfile ==
+## Opusfile ##
-Library for decoding .opus files, including seeking support.
+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 [email protected].
+
+Programming documentation is available in tree and online at
+https://opus-codec.org/docs/