From 0dfad168a001ecefe90434af82ff5e85659eaac6 Mon Sep 17 00:00:00 2001
From: Nico Alt <nicoalt@posteo.org>
Date: Wed, 6 Feb 2019 22:03:05 +0100
Subject: [PATCH] Add a readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c653c01
--- /dev/null
+++ b/README.md
@@ -0,0 +1,22 @@
+# Briar GTK
+
+A simple GTK app for [Briar](https://briar.app), built with Python and GNOME Builder.
+It uses the
+[Briar REST API](https://code.briarproject.org/briar/briar/blob/master/briar-headless/README.md)
+and therefore requires Java.
+
+## Design Goals
+
+* Intuitive and simple UI, adaptive to different screen sizes (desktop and mobile devices)
+
+## License
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as
+published by the Free Software Foundation, either version 3 of the
+License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+[GNU Affero General Public License](LICENSE.md) for more details.
-- 
GitLab