]> Sergey Matveev's repositories - go-opus.git/commitdiff
README: v2 import syntax
authorHraban Luyat <hraban@0brg.net>
Wed, 11 Jan 2017 00:09:38 +0000 (00:09 +0000)
committerHraban Luyat <hraban@0brg.net>
Wed, 11 Jan 2017 00:09:38 +0000 (00:09 +0000)
README.md

index b383a9ba0bce23b3993fa82705db7693c973feed..ac1c1336c7df72f30cd88707e9b56414eb91579d 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,5 +1,8 @@
 [![travis-ci status](https://api.travis-ci.org/travis-ci/travis-web.svg?branch=master "tarvis-ci build status")](https://travis-ci.org/hraban/opus)
 
+*WARNING: This version is not yet released! No backwards compatibility is
+guaranteed in the API until this notice is removed from the README.*
+
 ## Go wrapper for Opus
 
 This package provides Go bindings for the xiph.org C libraries libopus and
@@ -17,6 +20,12 @@ xiph.org opus libs:
 * decoders
 * stream handlers
 
+### Import
+
+```go
+import "gopkg.in/hraban/opus.v2"
+```
+
 ### Encoding
 
 To encode raw audio to the Opus format, create an encoder first: