From 6816052615341fc8049d47a49959c6c0e4c7697b Mon Sep 17 00:00:00 2001 From: Florian Dold Date: Mon, 23 Jan 2023 15:43:50 +0100 Subject: [PATCH] update READMEs --- packages/anastasis-core/README.md | 3 +++ packages/anastasis-webui/README.md | 3 +++ packages/demobank-ui/README.md | 2 ++ packages/taler-harness/README.md | 5 +++++ packages/taler-wallet-cli/README.md | 4 ++++ packages/taler-wallet-core/README.md | 4 ++++ packages/taler-wallet-embedded/README.md | 4 ++++ packages/taler-wallet-webextension/README.md | 4 ++++ packages/web-util/README | 0 packages/web-util/README.md | 3 +++ 10 files changed, 32 insertions(+) create mode 100644 packages/anastasis-core/README.md create mode 100644 packages/anastasis-webui/README.md create mode 100644 packages/taler-harness/README.md create mode 100644 packages/taler-wallet-cli/README.md create mode 100644 packages/taler-wallet-core/README.md create mode 100644 packages/taler-wallet-embedded/README.md create mode 100644 packages/taler-wallet-webextension/README.md delete mode 100644 packages/web-util/README create mode 100644 packages/web-util/README.md diff --git a/packages/anastasis-core/README.md b/packages/anastasis-core/README.md new file mode 100644 index 000000000..f3696c768 --- /dev/null +++ b/packages/anastasis-core/README.md @@ -0,0 +1,3 @@ +# anastasis-core + +This package implements the core client logic of Anastasis in TypeScript. diff --git a/packages/anastasis-webui/README.md b/packages/anastasis-webui/README.md new file mode 100644 index 000000000..e56da8a1c --- /dev/null +++ b/packages/anastasis-webui/README.md @@ -0,0 +1,3 @@ +# anastasis-webui + +This package implements a web-based client UI for GNU Anastasis. diff --git a/packages/demobank-ui/README.md b/packages/demobank-ui/README.md index 7f582c5ba..b8f96c5ea 100644 --- a/packages/demobank-ui/README.md +++ b/packages/demobank-ui/README.md @@ -1,5 +1,7 @@ # Taler Demobank UI +Web-based user interface for the libeufin demobank. + ## CLI Commands - `pnpm install`: Installs dependencies diff --git a/packages/taler-harness/README.md b/packages/taler-harness/README.md new file mode 100644 index 000000000..cac904f8e --- /dev/null +++ b/packages/taler-harness/README.md @@ -0,0 +1,5 @@ +# taler-harness + +This package implements the `taler-harness` CLI tool. It contains integration +tests for GNU Taler and GNU anastasis, as well as various helpers for managing +deployments of GNU Taler. diff --git a/packages/taler-wallet-cli/README.md b/packages/taler-wallet-cli/README.md new file mode 100644 index 000000000..c75ef8130 --- /dev/null +++ b/packages/taler-wallet-cli/README.md @@ -0,0 +1,4 @@ +# taler-wallet-cli + +This package provides `taler-wallet-cli`, the command-line interface for the +GNU Taler wallet. diff --git a/packages/taler-wallet-core/README.md b/packages/taler-wallet-core/README.md new file mode 100644 index 000000000..73da40caf --- /dev/null +++ b/packages/taler-wallet-core/README.md @@ -0,0 +1,4 @@ +# taler-wallet-core + +This package implements `taler-wallet-core`, the main logic and storage +for the GNU Taler wallet. diff --git a/packages/taler-wallet-embedded/README.md b/packages/taler-wallet-embedded/README.md new file mode 100644 index 000000000..b0444b208 --- /dev/null +++ b/packages/taler-wallet-embedded/README.md @@ -0,0 +1,4 @@ +# taler-wallet-embedded + +Minimal wrapper and build system code to make `taler-wallet-core` run +on embedded interpreters (currently NodeJS via akono, and `quickjs-tart`). diff --git a/packages/taler-wallet-webextension/README.md b/packages/taler-wallet-webextension/README.md new file mode 100644 index 000000000..a29147c0d --- /dev/null +++ b/packages/taler-wallet-webextension/README.md @@ -0,0 +1,4 @@ +# taler-wallet-webextension + +This package contains the implementation of the GNU Taler wallet browser extension, +using the cross-browser WebExtension APIs. diff --git a/packages/web-util/README b/packages/web-util/README deleted file mode 100644 index e69de29bb..000000000 diff --git a/packages/web-util/README.md b/packages/web-util/README.md new file mode 100644 index 000000000..d1465aa71 --- /dev/null +++ b/packages/web-util/README.md @@ -0,0 +1,3 @@ +# web-util + +Common utilities for other web applications in this repository.