From 5634c7b04da619669f2f29f6798c03982be05180 Mon Sep 17 00:00:00 2001
From: sanine <sanine.not@pm.me>
Date: Thu, 25 Aug 2022 12:47:35 -0500
Subject: add README.md

---
 README.md | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..38207f1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,26 @@
+mossrose
+========
+
+> *Portulaca grandiflora*
+
+A minimal-dependency PortAudio-based audio mixer library. It doesn't *load* audio; you'll need to do that yourself.
+
+
+api
+---
+
+### `int mr_init(double sample_rate, int n_channels)` ###
+
+Initialize mossrose with `n_channels` worth of audio, at `sample_rate` Hz. Returns 0 on success and 1 otherwise.
+
+
+### `int mr_terminate()` ###
+
+Terminate mossrose.
+
+
+### `int mr_play(float *left, float *right, size_t n_samples, int channel)` ###
+
+Play a sound. Either `left` or `right` may be NULL, but not both. If `channel` is non-negative, 
+it will use that channel; otherwise, it will use the first available free channel. Returns the 
+channel used on success, or -1 on failure.
-- 
cgit v1.2.1