add note about stability

11 years ago · 627fb354ad
parent 2b4729a7d7
commit 627fb354ad
1 changed files with 2 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -1,6 +1,8 @@
 # Libnyquist
 Libnyquist is a small C++11 library for reading sampled audio data from disk or memory. It's ideal to use as an audio asset frontend for games, audio sequencers, music players, and more.

+*The library is under active development and the API should be considered unstable. Check the Github issues queue for the state of the alpha.*
+
 The library steers away from patent-encumbered formats and those with non-BSD licensed codec implementations (such as MP3 and AAC, respectively). 

 Libnyquist is meant to be statically linked, which is not the case with other popular libraries like libsndfile (LGPL). Furthermore, the library is not concerned with legacy format support (for instance, A-law PCM encoding or SND files).