From 627fb354ad9b8110f38d6a49ee0e4a145ae785a8 Mon Sep 17 00:00:00 2001 From: Dimitri Diakopoulos Date: Sun, 17 May 2015 00:11:56 -0700 Subject: [PATCH] add note about stability --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 660661f..6abd646 100644 --- 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).