mirror of
https://github.com/joinmarket-webui/jam.git
synced 2026-08-14 12:43:26 +02:00
92 lines
4.8 KiB
Markdown
92 lines
4.8 KiB
Markdown
<div align="center">
|
|
<img src="docs/assets/readme-header-light.svg#gh-light-mode-only" alt="Jam: Your sats. Your privacy. Your profit.">
|
|
<img src="docs/assets/readme-header-dark.svg#gh-dark-mode-only" alt="Jam: Your sats. Your privacy. Your profit.">
|
|
</div>
|
|
|
|
<p align="center">
|
|
<strong>⚠️ Jam is beta software. Use with caution. ⚠️</strong>
|
|
</p>
|
|
|
|
<h3 align="center">
|
|
<a href="#-installation">Installation</a>
|
|
<span> · </span>
|
|
<a href="#-features">Features</a>
|
|
<span> · </span>
|
|
<a href="#-contribute">Contribute</a>
|
|
<span> · </span>
|
|
<a href="#%EF%B8%8F-development">Development</a>
|
|
</h3>
|
|
|
|
---
|
|
|
|
Jam is a web interface for [JoinMarket](https://github.com/JoinMarket-Org/joinmarket-clientserver/) focusing on user-friendliness and ease-of-use.
|
|
It aims to provide sensible defaults and be easy to use for beginners while still having the features advanced users expect.
|
|
|
|
- 💬 Join our [Matrix room](https://matrix.to/#/%23jam:bitcoin.kyoto) to get help and [contribute](https://jamdocs.org/contribute/)!
|
|
- 📚 Check out the [documentation](https://jamdocs.org) and the [wiki](https://github.com/joinmarket-webui/jam/wiki) for resources such as meeting notes, call recordings, ideas, and discussions.
|
|
|
|
|
|
## 📸
|
|
|
|
<div align="center">
|
|
<img src="docs/assets/screenshot-light.png#gh-light-mode-only" width="80%" alt="Jam Screenshot">
|
|
<img src="docs/assets/screenshot-dark.png#gh-dark-mode-only" width="80%" alt="Jam Screenshot">
|
|
</div>
|
|
|
|
## 📦 Installation
|
|
|
|
We're aiming to make Jam available for different node systems to make installation as painless as possible.
|
|
If your node system of choice is missing, feel free to integrate it and let us know so we can add it here.
|
|
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th style="text-align:center"><img src="docs/assets/raspiblitz-dark.svg#gh-light-mode-only" height="50px" alt="RaspiBlitz Logo" /><img src="docs/assets/raspiblitz-light.svg#gh-dark-mode-only" width="45px" alt="RaspiBlitz Logo" /></th>
|
|
<th style="text-align:center"><img src="docs/assets/umbrel.svg" width="45px" alt="Umbrel Logo" /></th>
|
|
<th style="text-align:center"><img src="docs/assets/citadel.png" width="45px" alt="Citadel Logo" /></th>
|
|
<th style="text-align:center"><img src="docs/assets/mynode.png" width="45px" alt="MyNode Logo" /></th>
|
|
<th style="text-align:center"><img src="docs/assets/start9.png" width="45px" alt="Start9 Logo" /></th>
|
|
<th style="text-align:center"><img src="docs/assets/raspibolt.png" width="45px" alt="RaspiBolt Logo" /></th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td style="text-align:center"><a href="https://github.com/rootzoll/raspiblitz">RaspiBlitz</a>: v1.7.2*</td>
|
|
<td style="text-align:center"><a href="https://getumbrel.com">Umbrel</a>: v0.4.15</td>
|
|
<td style="text-align:center"><a href="https://runcitadel.space">Citadel</a>: v0.0.1</td>
|
|
<td style="text-align:center"><a href="https://mynodebtc.com">MyNode</a>: v0.3.05</td>
|
|
<td style="text-align:center"><a href="https://start9.com">Start9</a>: v0.3.3</td>
|
|
<td style="text-align:center"><a href="https://raspibolt.org">RaspiBolt</a>: v3</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
Refer to [the installation docs](https://jamdocs.org/software/installation/) for more information on integrations as well as manual installation instructions.
|
|
|
|
## 🍊 Features
|
|
|
|
- [x] Spending from the wallet
|
|
- [x] Spending from the wallet via collaborative transactions
|
|
- [x] Running the yield generator
|
|
- [x] Scheduled transactions
|
|
- [x] Viewing the orderbook
|
|
- [x] Support for fidelity bonds
|
|
- [ ] PayJoin support
|
|
|
|
Refer to the [milestones](https://github.com/joinmarket-webui/jam/milestones) for a rough roadmap. Feature requests are [tracked as issues](https://github.com/joinmarket-webui/jam/issues).
|
|
|
|
## 🧑💻 Contribute
|
|
|
|
This is a [free and open-source](https://jamdocs.org/philosophy/01-free-software/) software project and we love receiving pull-requests, bug reports, ideas, and feedback from everyone.
|
|
|
|
There are many ways you can contribute: testing, sharing ideas, writing documentation, creating tutorials, and—of course—writing code. Refer to the [general contribution guidelines](https://jamdocs.org/contribute/) to get started.
|
|
|
|
## 🛠️ Development
|
|
|
|
Want to get your hands dirty with code? Great! [CONTRIBUTING.md](CONTRIBUTING.md) and [docs/developing.md](docs/developing.md) are where it's at.
|
|
|
|
## 🏛️ History
|
|
|
|
This project builds upon the [jm-web-client](https://github.com/JoinMarket-Org/jm-web-client) which was developed by [Shobhitaa](https://github.com/shobhitaa), [Abhishek](https://github.com/abhishek0405), and [waxwing](https://github.com/AdamISZ) himself. Many people contributed over time, some of which are [listed here](https://github.com/joinmarket-webui/jam/graphs/contributors).
|
|
|
|
Jam and JoinMarket are separate projects. For more information on JoinMarket, see the [JoinMarket GitHub Page](https://github.com/JoinMarket-Org/joinmarket-clientserver).
|