--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/WIP:gsmhr	Sat Aug 17 23:11:51 2024 +0000
@@ -0,0 +1,17 @@
+The present state of gsm-codec-lib Hg repository is a Work In Progress
+with respect to addition of libgsmhr1, a WIP library seeking to implement
+GSM-HR codec in a way that fits into the grander vision of Themyscira Wireless.
+
+In the present WIP state absolutely NO commitments are being made with regard
+to API stability - the current WIP API can change at any moment!
+
+As a reminder, NO binary packages or build recipes should be made from this
+WIP state!  If you don't need GSM-HR codec, please use the latest stable
+release tarball; if you do need GSM-HR codec, please wait until libgsmhr1
+reaches version 1.0.0 per SemVer.
+
+If you need some GSM-HR functions (e.g., frame packing and unpacking) and
+cannot wait for libgsmhr1 version 1.0.0, the acceptable interim solution is to
+lift those individual C modules out of this repository and plop them directly
+into your own code - doing so would be more acceptable than making installable
+packages out of the present WIP.