Skip to content

Commit fbdb9f9

Browse files
authored
Merge pull request #1978 from synonymdev/update-readme
2 parents 67979a5 + 6c22d2f commit fbdb9f9

File tree

1 file changed

+17
-49
lines changed

1 file changed

+17
-49
lines changed

README.md

Lines changed: 17 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -1,63 +1,31 @@
1-
# Bitkit
1+
<p align="left">
2+
<img src="./src/assets/bitkit-logo.svg" width="175px" alt="Bitkit Logo"/>
3+
</p>
24

3-
https://github.com/synonymdev/bitkit/assets/5798170/99807c8a-2cb8-41f5-810f-6146e633e95b
5+
Bitkit is a self-custodial wallet powering lightning-fast bitcoin payments. Hold your keys, unlock your sovereignty.
46

5-
**⚠️ Beta software that may put your money at risk.**
7+
📲 Download: **[Apple App Store](https://apps.apple.com/app/bitkit-wallet/id6502440655)[Google Play Store](https://play.google.com/store/apps/details?id=to.bitkit)**
68

7-
**⚠️ We recommend using only small amounts.**
9+
https://github.com/synonymdev/bitkit/assets/93796166/5ed22eca-077d-4f8e-bf47-5045912df6fb
810

9-
**⚠️ Don’t use the same seed on multiple devices.**
11+
## Features
12+
-**Instant Payments:** Send and receive instantly with your own node on the Lightning Network. No third-party custodians required.
13+
- 🔗 **On-chain Payments:** Make on-chain and Lightning payments seamlessly from within a single wallet.
14+
- 🔐 **Recovery Phrase:** Import your 12 words into any self-custodial wallet to restore your savings balance.
15+
- 👤 **Payable Contacts:** Add and pay friends without having to copy and paste addresses or invoices.
1016

11-
[⬇ Android - Download latest APK](https://github.com/synonymdev/bitkit/releases)
12-
13-
[⬇ iPhone - Download latest TestFlight app](https://testflight.apple.com/join/lGXhnwcC)
14-
15-
16-
## Overview
17-
18-
Reclaim your digital life with Bitkit.
19-
20-
Bitkit offers on-chain and lightning transactions, as well as user-controlled social profiles and contacts; easy payments to contacts; key-based log-ins; and data streaming from private and public feeds into widgets. All these latter features have been built using [Slashtags](https://slashtags.to/).
21-
22-
Synonym's mission is for users to have control over their own data and operate in a Web that is censorship-resistant, private, and free from walled gardens. Bitkit is Synonym’s crack at harmonizing such digital autonomy with a great user experience.
23-
24-
Bitkit is a mobile application available on Android and iOS, and implemented using React-Native.
25-
26-
## The problem
27-
28-
Society, the economy, and the Web suffer from oppressive central controls, resulting in censorship, privacy breaches, and monopoly behaviors. Users need P2P tools that set them free.
29-
30-
## Bitkit's solution
31-
32-
Bitkit offers a Bitcoin wallet that supports both on-chain and lightning transactions. The application runs a custom, non-routing Lightning node created with the [Lightning Development Kit](https://github.com/lightningdevkit) on the user's mobile phone. By default you connect to Synonym's Electrum-Bitcoin Core server, but you can also connect to your own server. We on-board users to Lightning through our lightning service provider (LSP) [Blocktank](https://github.com/synonymdev/blocktank-client). In the future, we will also enable connections to other LSPs and peers on the network.
33-
34-
Users can back up their Bitcoin and Lightning keys with a standard BIP-39 seed and optional password. Lightning channel data is automatically replicated on our a backup server. The data is encrypted on the client-side before it is sent to our server to ensure privacy. You can view our code [here](https://github.com/synonymdev/bitkit-backup-client).
35-
36-
The other main features Bitkit supports are as follows:
37-
38-
* 📱 Social profiles and contacts
39-
* 💸 Easy payments to profiles
40-
* 🔑 Key-based account logins
41-
* 📊 Streaming of private and public data feeds into widgets
42-
43-
All these additional features are powered by Slashtags: a collection of software modules and specifications that complements the Bitcoin and Lightning stacks in the building of peer-to-peer applications, specifically to enable decentralized identities and web-of-trust reputation systems. You can view our JavaScript-based software development kit which has been used for the Bitkit wallet [here](https://github.com/synonymdev/slashtags).
44-
45-
You can experiment with Bitkit's Slashtags features in our [playground](https://slashtags.to/#playground). We currently support four public data widgets:
46-
47-
* 📈 [Bitcoin Price Feed](https://github.com/synonymdev/slashtags-widget-price-feed) - [📲 Add to your phone](https://slashtags.to/playground/price)
48-
* 📰 [Bitcoin News Feed](https://github.com/synonymdev/slashtags-widget-news-feed) - [📲 Add to your phone](https://slashtags.to/playground/headlines)
49-
* 📊 [Bitcoin Block Feed](https://github.com/synonymdev/slashtags-widget-bitcoin-feed) - [📲 Add to your phone](https://slashtags.to/playground/blocks)
50-
* 📚 [Bitcoin Facts Feed](https://github.com/synonymdev/slashtags-widget-facts-feed) - [📲 Add to your phone](https://slashtags.to/playground/facts)
51-
52-
Slashtags user data is automatically replicated via our [seeding server](https://github.com/synonymdev/slashtag-seeding-server). In this way, user data is always available. In addition, it allows the user to restore all their Slashtags data from just their BIP-39 seed and optional password.
17+
To learn more, visit [our website](https://bitkit.to/).
5318

5419
## Support
5520

56-
If you are experiencing any problems with Bitkit, please open an issue and use the template provided, or reach out to us on [Telegram](https://t.me/bitkitchat).
21+
- Visit [our help center](https://help.bitkit.to/)
22+
- Open an [issue](https://github.com/synonymdev/bitkit/issues/new/choose)
23+
- Message us on [Telegram](https://t.me/Bitkit_support_bot)
24+
- Reach out on [our live chat](https://bitkit.to/)
5725

5826
## Translations
5927

60-
[Join our Transifex project](https://explore.transifex.com/synonym/bitkit/) to help translate Bitkit into your local language and boost Bitcoin adoption worldwide. Questions? Connect with our team on [Discord](https://discord.gg/uRMHufhuTA).
28+
Help us boost Bitcoin adoption worldwide. Join [our Transifex project](https://explore.transifex.com/synonym/bitkit/)!
6129

6230
## Installation
6331

0 commit comments

Comments
 (0)