Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: README Update #389

Merged
merged 2 commits into from
Oct 7, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 17 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,25 @@
# Boltz-backend
# Boltz Backend

[![CI](https://github.com/BoltzExchange/boltz-backend/workflows/CI/badge.svg?branch=master)](https://github.com/BoltzExchange/boltz-backend/actions)
[![Discord](https://img.shields.io/discord/547454030801272832.svg)](https://discordapp.com/invite/QBvZGcW)
[![Version](https://img.shields.io/npm/v/boltz-backend.svg)](https://www.npmjs.com/package/boltz-backend)

[Boltz-backend](https://github.com/BoltzExchange/boltz-backend/) is the backend powering swaps at [Boltz](https://boltz.exchange/).

⚠️ All [boltz-backend](https://github.com/BoltzExchange/boltz-backend/) code after [commit 3bcd9ae](https://github.com/BoltzExchange/boltz-backend/commit/3bcd9ae43db64add1bd72fe639bc38cfa727da04) moved to [BSL 1.1](https://mariadb.com/bsl11/), a "source available" license which turns into an open source license after 4 years, see [LICENSE](https://github.com/BoltzExchange/boltz-backend/blob/master/LICENSE) and [BSL FAQs](https://mariadb.com/bsl-faq-mariadb/) for details. ⚠️
[Boltz Backend](https://github.com/BoltzExchange/boltz-backend/) is the backend powering swaps at [Boltz](https://boltz.exchange/).

## Documentation

Documentation of [boltz-backend](https://github.com/BoltzExchange/boltz-backend/) can be found at [docs.boltz.exchange](https://docs.boltz.exchange/)
Documentation can be found at [docs.boltz.exchange](https://docs.boltz.exchange/)

## ⚠️ License ⚠️

Boltz Backend after [commit 3bcd9ae](https://github.com/BoltzExchange/boltz-backend/commit/3bcd9ae43db64add1bd72fe639bc38cfa727da04) is licensed under [BSL 1.1](https://mariadb.com/bsl11/), a "source available" license which automatically turns into an open source license after 4 years, see [LICENSE](LICENSE) and [BSL FAQs](https://mariadb.com/bsl-faq-mariadb/) for details. If you are interested in a partnership to run the latest version please contact us at [[email protected]](mailto:[email protected]).

Current Partnerships:
* [Diamond Hands](https://swap.diamondhands.technology/)

## Resources

* Get Help: [Discord](https://discord.gg/QBvZGcW)
* Read our Blog: [Substack](https://blog.boltz.exchange/)
* Follow us: [X/Twitter](https://twitter.com/Boltzhq) | [Nostr](https://snort.social/p/npub1psm37hke2pmxzdzraqe3cjmqs28dv77da74pdx8mtn5a0vegtlas9q8970)
* Open a channel with us: [CLN](https://amboss.space/node/02d96eadea3d780104449aca5c93461ce67c1564e2e1d73225fa67dd3b997a6018) | [LND](https://amboss.space/node/026165850492521f4ac8abd9bd8088123446d126f648ca35e60f88177dc149ceb2)