From 54fec752796846389ae187834c19e5720a1c43a8 Mon Sep 17 00:00:00 2001
From: Florian Dold <florian.dold@gmail.com>
Date: Mon, 19 Aug 2019 13:29:59 +0200
Subject: more standardized binaries, better README

---
 README | 46 +++++++++++++++++++++++++++++-----------------
 1 file changed, 29 insertions(+), 17 deletions(-)

(limited to 'README')

diff --git a/README b/README
index ece8c2fba..f2256cc48 100644
--- a/README
+++ b/README
@@ -1,34 +1,46 @@
 GNU Taler Wallet
 ================
 
-Cross-browser GNU Taler wallet written for the WebExtensions API.
+This package implements a wallet for GNU Taler in TypeScript.
 
+It can be run on different platforms:
+1. As a cross-browser extension, written for the WebExtension API
+2. As a Node.JS package
 
-Installation
+
+Dependencies
 ============
 
+Dependencies are managed as NPM dependencies.  For performance reasons,
+we use `yarn' as a replacement for `npm' in the build system.
+
+For cryptographic operations, the wallet uses an emscripten-compiled
+library.  The binary files for this library are in `./emscripten'.
+The instructions for building this binary from scrach can be found
+in the libtaler-emscripten repository:
+
+https://git.taler.net/libtalerutil-emscripten.git/
+
+
+Building from source (Web Extension)
+======================================
+
 Run `./configure && make' to create an archive
 containing the extension in ./build/taler-wallet-$VERSION.zip
 
-Dependencies
-============
 
-See thirdparty/README for a list of dependencies that are checked into this
-repository as a git subtree.
+Building from source (Node.JS)
+======================================
 
-This project also has the following third-party runtime dependencies, which
-are checked in compiled or minified form:
-- React (Facebook Inc., BSD License)
+Run `./configure && make tsc' to build the wallet.  The command line
+interface for the wallet is available in `./bin/taler-wallet-cli'.
 
 
-Emscripten compiled dependencies:
-* libgnunetutil
-* libgnunetjson
-* libgcrypt
-* libunistring
+Installation
+============
 
+To install the package permanently on your system, run:
 
-Documentation
-=============
+$ npm install -g --prefix $PREFIX .
 
-See the documentation at http://doc.taler.net/dev-wallet-wx.html
+The binaries will be installed to `$PREFIX/bin'.
-- 
cgit v1.2.3