aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README35
1 files changed, 35 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 000000000..7ea8dd11c
--- /dev/null
+++ b/README
@@ -0,0 +1,35 @@
+GNU Taler WebExtension Wallet
+=============================
+
+Cross-browser GNU Taler wallet written for the WebExtensions API.
+
+
+Installation
+============
+
+Run `./configure && make' to create an archive
+containing the extension in ./build/taler-wallet-$VERSION.zip
+
+Dependencies
+============
+
+This project has the following third-party runtime dependencies:
+
+* URI.js: URL parsing and construction
+* mithril.js: view-layer based on virtual DOMs
+* jed: gettext parsing for JavaScript
+* lodash: standard helper library for JavaScript
+* system.js: Module loader for browsers that don't support
+ ES6 modules
+
+Emscripten compiled dependencies:
+* libgnunetutil
+* libgnunetjson
+* libgcrypt
+* libunistring
+
+
+Documentation
+=============
+
+See the documentation at http://doc.taler.net/dev-wallet-wx.html