# Joinmarket documentation

## Contents

1. User guide material

   a. [Installation guide (BUT use the install script as per README, first)](INSTALL.md)

   b. [Main usage guide, covers wallet funding, creation, control, transactions etc.](./USAGE.md)

   c. [Running a yield generator general basics](./YIELDGENERATOR.md)

   d. [Running JoinmarketQt for coinjoins and wallet control](JOINMARKET-QT-GUIDE.md)

   e. [Important info for takers - how to deal with commitments](./SOURCING-COMMITMENTS.md)

   f. [Important info for makers - how to create and use fidelity bonds](./fidelity-bonds.md)

   g. [How to run the tumbler script (or in Qt) for a good privacy effect](tumblerguide.md)

   h. [How to run the orderbook script locally](orderbook.md)

   i. [How to do payjoins with Joinmarket](./PAYJOIN.md)

   j. [How to use SNICKER features (currently not active)](SNICKER.md)


2. More useful for developers, mainly

   a. [How to get a test setup working, with regtest](TESTING.md)

   b. [How to use jmwalletd and the RPC-API to the Joinmarket wallet](JSON-RPC-API-using-jmwalletd.md)

   c. [Some background notes on Joinmarket's architecture (client-daemon etc.)](architecture-notes.md)

   d. [Some notes about project goals and progress, usually not well updated](TODO.md)

3. Older guides on upgrades/changes that are no longer relevant, ignore:

   a. [Upgrading to p2wpkh/native segwit (which is now default)](NATIVE-SEGWIT-UPGRADE.md)

   b. [Upgrading the IRC config (changed in 2018)](config-irc-update.md)
