summary refs log tree commit diff stats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..4ca984c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,18 @@
+# Tiny Desktop Portal
+
+A modular and lightweight alternative to `xdg-desktop-portal`, primarily
+for use with *non*-flatpak applications.
+
+It's not intended to provide the security guarantees of
+`xdg-desktop-portal`, but merely to allow applications to depend on an
+`xdg-desktop-portal`-compatible API and use native file choosers and so
+on. The primary goal is to be lightweight, such that it can be used on
+memory-constrained devices, and only provide what the user needs.
+
+Future goals include native Android/Termux integration, especially for
+the file chooser. However, let's get the baseline working first, shall
+we?
+
+## TODO
+
+Nothing exists right now.