Skip to content

Commit

Permalink
Merge pull request #1978 from synonymdev/update-readme
Browse files Browse the repository at this point in the history
  • Loading branch information
mattcrv authored Jun 13, 2024
2 parents 67979a5 + 6c22d2f commit fbdb9f9
Showing 1 changed file with 17 additions and 49 deletions.
66 changes: 17 additions & 49 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,63 +1,31 @@
# Bitkit
<p align="left">
<img src="./src/assets/bitkit-logo.svg" width="175px" alt="Bitkit Logo"/>
</p>

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

**⚠️ Beta software that may put your money at risk.**
📲 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)**

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

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

[⬇ Android - Download latest APK](https://github.com/synonymdev/bitkit/releases)

[⬇ iPhone - Download latest TestFlight app](https://testflight.apple.com/join/lGXhnwcC)


## Overview

Reclaim your digital life with Bitkit.

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/).

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.

Bitkit is a mobile application available on Android and iOS, and implemented using React-Native.

## The problem

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.

## Bitkit's solution

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.

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).

The other main features Bitkit supports are as follows:

* 📱 Social profiles and contacts
* 💸 Easy payments to profiles
* 🔑 Key-based account logins
* 📊 Streaming of private and public data feeds into widgets

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).

You can experiment with Bitkit's Slashtags features in our [playground](https://slashtags.to/#playground). We currently support four public data widgets:

* 📈 [Bitcoin Price Feed](https://github.com/synonymdev/slashtags-widget-price-feed) - [📲 Add to your phone](https://slashtags.to/playground/price)
* 📰 [Bitcoin News Feed](https://github.com/synonymdev/slashtags-widget-news-feed) - [📲 Add to your phone](https://slashtags.to/playground/headlines)
* 📊 [Bitcoin Block Feed](https://github.com/synonymdev/slashtags-widget-bitcoin-feed) - [📲 Add to your phone](https://slashtags.to/playground/blocks)
* 📚 [Bitcoin Facts Feed](https://github.com/synonymdev/slashtags-widget-facts-feed) - [📲 Add to your phone](https://slashtags.to/playground/facts)

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.
To learn more, visit [our website](https://bitkit.to/).

## Support

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).
- Visit [our help center](https://help.bitkit.to/)
- Open an [issue](https://github.com/synonymdev/bitkit/issues/new/choose)
- Message us on [Telegram](https://t.me/Bitkit_support_bot)
- Reach out on [our live chat](https://bitkit.to/)

## Translations

[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).
Help us boost Bitcoin adoption worldwide. Join [our Transifex project](https://explore.transifex.com/synonym/bitkit/)!

## Installation

Expand Down

0 comments on commit fbdb9f9

Please sign in to comment.