Skip to content

Commit

Permalink
Update README (#139)
Browse files Browse the repository at this point in the history
  • Loading branch information
fmrsabino authored and rmeissner committed Feb 9, 2018
1 parent b1c4200 commit f92e7f0
Showing 1 changed file with 14 additions and 6 deletions.
20 changes: 14 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Heimdall Android

**WARNING: Under development: When building the application, target a test environment (eg.: TestRPC). Don't use the application with real funds!**
**WARNING: Under development. Don't use the application with real funds! Application right now targets the Rinkeby test network. Switching to mainnet (or any other ethereum network) can be done by the user but it's its responsibility in doing so.**

## Goal
The goal of this project is to provide a 2FA-enabled Ethereum Wallet. This can be achieved by using the new [Gnosis Safe](https://github.com/gnosis/gnosis-safe) (the new version of our [Multisig Wallet](https://github.com/gnosis/MultiSigWallet)).
The goal of this project is to provide a 2FA-enabled Ethereum Wallet. This can be achieved by using the new [Gnosis Safe](https://github.com/gnosis/gnosis-safe-contracts) (the new version of our [Multisig Wallet](https://github.com/gnosis/MultiSigWallet)).

You can add multiple devices to the safe and secure your wallet by requiring a set of devices to confirm each transaction. Depending on you security setting and number of devices you can still access your funds even if you loose access to a device.

Expand All @@ -16,15 +16,16 @@ Deploying and interacting with your Gnosis Safe will also be much cheaper than w
* Transfer funds (ether or tokens)
* Address Book (so you don't need to memorize all addresses)
* Manage Tokens - verify token addresses that you trust so you can access their information easily
* Mnemonic reveal for active account
* Fiat prices for transaction costs (USD)
* Fingerprint support
* Add/Remove owner from deployed safes

### To be added
* Management of your safe (number of required confirmations, owners,...)
* Trezor support
* Transaction scanning with QRCode
* Fiat prices
* Fingerprint support
* Integration with external protocols/apps for signing
* Mnemonic reveal for active account


## Setup

Expand All @@ -46,5 +47,12 @@ Replace each field with the respective information (found in Fabric).

**If you don't want to setup Fabric for this project you can follow the steps present in this [page](https://docs.fabric.io/android/crashlytics/build-tools.html) to disable the integration. We will improve this integration in the future so it can be easily enabled/disabled**

### Firebase
Heimdall uses Firebase and your build will fail if you don't have the `google-services.json` file.

This file can be found in the Settings page of the Firebase project.

After getting access to the file, move it to the `app` module.

### Contribute
You can contribute to this repo by creating a Pull Request or an issue. Please follow the default template set for the Pull Requests.

0 comments on commit f92e7f0

Please sign in to comment.