Skip to content

Improve README presentation and visual clarity #6875

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.

Sign up for GitHub

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

Open
Ayush4958 wants to merge 2 commits into
base: sprint
Choose a base branch
from
Open

Improve README presentation and visual clarity #6875

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
577884c
Feat: Enhance the Readme File for better Reader Expierence
Ayush4958 Dec 18, 2025
50786af
Feat: Enhance the Readme File for better Reader Expierence
Ayush4958 Dec 18, 2025
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
52 changes: 29 additions & 23 deletions Readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,22 @@ This repository is the **canonical home of Bitcoin Keeper** and is maintained as

![image](https://github.com/user-attachments/assets/77c58e40-0172-4f73-aeb9-8a7851eb43eb)

<a href="https://play.google.com/store/apps/details?id=io.hexawallet.bitcoinkeeper">
<img src="https://bitcoinkeeper.app/wp-content/uploads/2025/02/Google-Play.svg" alt="Playstore" width="150" style="border: none; outline: none;"/>
</a>
<a href="https://apps.apple.com/us/app/bitcoin-keeper/id1545535925">
<img src="https://bitcoinkeeper.app/wp-content/uploads/2025/02/App-Store.svg" alt="Appstore" width="150" style="border: none; outline: none;"/>
</a>
<a href="https://github.com/bithyve/bitcoin-keeper/releases">
<img src="https://github.com/bithyve/bitcoin-keeper/assets/50690016/67693cf0-a059-4391-8b48-a9d46a55e71c" alt="PGP_APK" width="150" style="border: none; outline: none;"/>
</a>

## Features
<p align="center">
<a href="https://play.google.com/store/apps/details?id=io.hexawallet.bitcoinkeeper">
<img src="https://bitcoinkeeper.app/wp-content/uploads/2025/02/Google-Play.svg" alt="Playstore" width="150"/>
</a>

<a href="https://apps.apple.com/us/app/bitcoin-keeper/id1545535925">
<img src="https://bitcoinkeeper.app/wp-content/uploads/2025/02/App-Store.svg" alt="Appstore" width="150"/>
</a>

<a href="https://github.com/bithyve/bitcoin-keeper/releases">
<img src="https://github.com/bithyve/bitcoin-keeper/assets/50690016/67693cf0-a059-4391-8b48-a9d46a55e71c" alt="PGP_APK" width="150"/>
</a>
</p>


## ✨ Features
Create and manage *Bitcoin multisig wallets
Hardware wallet support for multisig setups
Recovery planning and inheritance-friendly structures
Expand All @@ -25,13 +30,13 @@ Fully interoperable with standard Bitcoin wallets and tools
No proprietary formats or walled gardens
All features are **free to use**. There are no subscriptions or paid tiers.

## Project Status
## 🚧 Project Status
Bitcoin Keeper is maintained openly by independent contributors.
Ongoing development and maintenance are supported by **grants and optional user tips**, allowing the project to remain independent, resilient, and aligned with its original principles.
The wallet is built so that users can always move their keys and funds elsewhere, regardless of the project’s future.


## Prerequisites
## 🧩 Prerequisites

Before getting started, make sure you have a proper [React Native development environment](https://reactnative.dev/docs/environment-setup) on your machine

Expand All @@ -42,7 +47,7 @@ Android Studio (for Android builds)
Xcode (for iOS builds)
Refer to platform-specific documentation for detailed setup requirements.

## Getting Started
## 🚀 Getting Started

1. Clone this repository to your local machine:

Expand All @@ -60,9 +65,9 @@ Refer to platform-specific documentation for detailed setup requirements.
yarn install
```

## Build and Run
## 🛠️ Build and Run

### Varients
### 🧪 Varients

The project has testnet and mainnet variants. The development variant is configured to use testnet and the production variant to use mainnet.

Expand All @@ -72,7 +77,7 @@ Start metro metro
yarn start
```

#### Development
#### 🧑‍💻 Development

To run the development app on a connected device or emulator:

Expand All @@ -88,7 +93,7 @@ yarn androidDevelopmentDebug
yarn ios --scheme=hexa_keeper_dev
```

#### Production
#### 🏭 Production

To run the production app on a connected device or emulator:

Expand All @@ -106,13 +111,13 @@ yarn ios --scheme=hexa_keeper

These commands will build and launch the app on the respective platforms.

## PGP
## 🔐 PGP

```bash
389F 4CAD A078 5AC0 E28A 0C18 1BEB DE26 1DC3 CF62
```

## Verify Authenticity of Android APK
## 🛡️ Verify Authenticity of Android APK

Please download an [APK](https://github.com/bithyve/bitcoin-keeper/releases) and keep all these files in the same directory: `Android APK file, SHA256SUM.asc, KEEPER_DETACHED_SIGN.sign`. Make a copy of `Android APK file` and rename it as `Android APK clone`.

Expand Down Expand Up @@ -172,19 +177,20 @@ issuer "hexa@bithyve.com"
Good signature from "Hexa Team (Hexa Bitcoin Wallet) <hexa@bithyve.com>"
```

## Testing
## 🧪 Testing

This project uses **Jest** as the testing framework. To run the tests, use the following command:

```bash
yarn test
```

## License
## 📄 License

This project is licensed under the **MIT License.**

## Community
## 🌍 Community

- Follow us on [Twitter](https://twitter.com/bitcoinKeeper_)
- Join our [Telegram](https://t.me/bitcoinkeeper)