70feeaa067
* docs(readme): update screenshots * docs(readme): update header * docs(readme): update warning & intro * docs(readme): link to Matrix, not Telegram * docs(readme): move previous work paragraph to history * docs(readme): update tagline * docs(readme): link to jamdocs.org/contribute * docs(readme): improved structure & wording |
||
|---|---|---|
| .github/workflows | ||
| .husky | ||
| .tx | ||
| docker/regtest | ||
| docs | ||
| public | ||
| scripts | ||
| src | ||
| .gitignore | ||
| .npmrc | ||
| CHANGELOG.md | ||
| CONTRIBUTING.md | ||
| LICENSE | ||
| package-lock.json | ||
| package.json | ||
| README.md | ||
| tsconfig.json | ||
| typings.d.ts | ||
⚠️ Jam is beta software. Use with caution. ⚠️
Installation · Features · Contribute · Development
Jam is a web interface for JoinMarket 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 to get help and contribute!
- 📚 Check out the documentation and the wiki for resources such as meeting notes, call recordings, ideas, and discussions.
📸
📦 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.
  |
 |
 |
|---|---|---|
| RaspiBlitz: v1.7.2* | Umbrel: v0.4.15 | Citadel: v0.0.1 |
Refer to the installation docs for more information on integrations as well as manual installation instructions.
🍊 Features
- Spending from the wallet
- Spending from the wallet via collaborative transactions
- Running the yield generator
- Scheduled transactions
- Support for fidelity bonds
- PayJoin support
Refer to the milestones for a rough roadmap. Feature requests are tracked as issues.
🧑💻 Contribute
This is a free and open-source 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 to get started.
🛠️ Development
Want to get your hands dirty with code? Great! CONTRIBUTING.md and docs/developing.md are where it's at.
🏛️ History
This project builds upon the jm-web-client which was developed by Shobhitaa, Abhishek, and waxwing himself. Many people contributed over time, some of which are listed here.
Jam and JoinMarket are separate projects. For more information on JoinMarket, see the JoinMarket GitHub Page.