summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README11
1 files changed, 11 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..ccc118e
--- /dev/null
+++ b/README
@@ -0,0 +1,11 @@
+libmateweather is a library to access weather information from online
+services for numerous locations.
+
+libmateweather isn't supported in the devel platform, which means OS vendors
+won't guarantee the API/ABI long-term, but authors of open source apps
+should feel free to use libmateweather as users can always recompile against
+a new version.
+
+To use libmateweather in your code, you need to define the
+MATEWEATHER_I_KNOW_THIS_IS_UNSTABLE preprecessor symbol, e.g. by adding
+-DMATEWEATHER_I_KNOW_THIS_IS_UNSTABLE to your CFLAGS.