From ddf4221e0a2be17745fc1fe854d8545212ff9c49 Mon Sep 17 00:00:00 2001 From: Salvatore Ingala <6681844+bigspider@users.noreply.github.com> Date: Mon, 21 Oct 2024 17:16:40 +0200 Subject: [PATCH] Added README for the /docs folder --- doc/README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 doc/README.md diff --git a/doc/README.md b/doc/README.md new file mode 100644 index 00000000..61db024d --- /dev/null +++ b/doc/README.md @@ -0,0 +1,14 @@ +# Ledger Bitcoin App Developer Documentation + +This documentation provides detailed information for developers working with the Ledger Bitcoin app. + +For many use cases, the code examples provided in the following client libraries might be sufficient to get started: +- [Python client library](../bitcoin_client) +- [JavaScript client library](../bitcoin_client_js) +- [Rust client library](../bitcoin_client_rs) + +If you need to go deeper into the rabbit hole 🐇🕳️, refer to the following documents: +- [bitcoin.md](bitcoin.md): Low-level documentation of the Bitcoin app's communication protocol and commands. +- [merkle.md](merkle.md): Advanced details on techniques used in the Bitcoin app's secured and scalable communication protocol. +- [wallet.md](wallet.md): Information on the types of scripts supported by the Ledger Bitcoin app and the security requirements for multi-user or multi-key spending policies. +- [debugging.md](debugging.md): Guidance on how to diagnose and resolve issues.