From 5b3559bf0e67d6483b0a3ff7cd0356aeb5320192 Mon Sep 17 00:00:00 2001 From: Lucas Schwiderski Date: Wed, 22 Jun 2022 15:33:02 +0200 Subject: [PATCH] doc: Add disclaimer about current project state --- README.adoc | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.adoc b/README.adoc index 69dbf9a..77416f8 100644 --- a/README.adoc +++ b/README.adoc @@ -31,6 +31,10 @@ image:{url-luarocks-badge}[LuaRocks Package, link={url-luarocks-link}] https://freedesktop.org/software/pulseaudio/doxygen/index.html[libpulse] bindings for use with a GLib MainLoop via https://github.com/lgi-devs/lgi/[LGI]. +The project is still in a development state. It hasn't been fully tested yet, and not all functions from libpulse +have a corresponding binding yet. +Please do report anything that's missing or not working correctly. + == Quick Start Install https://github.com/lgi-devs/lgi[lgi] and _lua_libpulse_glib_ from LuaRocks: @@ -38,7 +42,7 @@ Install https://github.com/lgi-devs/lgi[lgi] and _lua_libpulse_glib_ from LuaRoc [source,shell] ---- luarocks install lgi -luarocks install lua-libpulse-glib +luarocks install --dev lua-libpulse-glib ---- [source,lua]