This repository has been archived by the owner on Mar 23, 2023. It is now read-only.
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
update readme and add license/contributing file
- Loading branch information
1 parent
75c7db5
commit e0b3f01
Showing
3 changed files
with
103 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
# BOUNTY Program | ||
ARK has a bounty program for all accepted PR (Pull Requests) for this repository | ||
|
||
More information can be found at https://blog.ark.io/200-000-ark-bounty-for-developers-in-the-1st-year-76aa44304012 | ||
|
||
Before pushing PR, please [jump in our slack #development](https://ark.io/slack) channel in order to discuss your contributions or to connect with other ARKvelopers. | ||
|
||
# Guidelines | ||
- pickup any of the existing issues or if you find an issue make a PR, | ||
- only one PR reward will be awarded per issue it fixes, | ||
- solving an open issue will increase your chances to be picked up as any of the monthly bounty winners. | ||
|
||
# Accepted PR | ||
- increase general code quality, | ||
- add meaningfull tests, | ||
- correct bug, | ||
- add new features, | ||
- improve documentation, | ||
- create something new for ARK. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
MIT License | ||
|
||
Copyright (c) 2017 Ark.io, Lúcio Rubens <lucio@ark.io>, Alex Barnsley <alex@ark.io> | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,18 +1,74 @@ | ||
ARK wallet | ||
![ARK Mobile](https://i.imgur.com/0BjkC9C.png) | ||
|
||
## Development | ||
# Ark Mobile | ||
> A Wallet for Everyone | ||
### Requirements | ||
ARK’s mobile wallet is a hybrid application (using the same codebase for Android and iOS which helps with coordinated development). Created using Ionic framework and ARK’s [TypeScript API](https://github.com/ArkEcosystem/ark-ts) to interact with the ARK network via your mobile phone, anytime, anywhere (as long as you have an internet connection). | ||
|
||
## Download | ||
|
||
- [Google Play](https://play.google.com/store/apps/details?id=io.ark.wallet.mobile) | ||
- App Store (Waiting for approval from Apple) | ||
- Ionic View (for iOS): | ||
1. Install [Ionic View — Test Ionic Apps](https://itunes.apple.com/us/app/ionic-view-test-ionic-apps/id1271789931?mt=8) | ||
1. Open and click the eye at the bottom | ||
1. Enter the ID **0894ffa2** and “View App” | ||
|
||
## Screenshots | ||
|
||
|
||
|
||
## Features | ||
|
||
- Import your existing passphrase (import by QR Scanner or write/paste your passphrase). | ||
- Generate a new passphrase. | ||
- Encrypt access to your profile with a custom 6 digit PIN (AES256+PBKDF2). | ||
- Most transaction types are available: send, receive, vote, unvote, register a delegate. | ||
- Connects to both mainnet and devnet. | ||
- Option for additional profiles (separate profiles for different ARK addresses or networks). | ||
- Option to add contacts and easily transact with them. | ||
- Total balance of your combined ARK addresses. | ||
- Wallet backup - input your selected PIN to decrypt your wallet and gain view of your private data. | ||
- Change PIN - if you want to change your encryption/decryption PIN you can easily do so.. | ||
- Clear Data — you can clear all your data from the phone. | ||
- Overview of network status with an option to change peer. | ||
- Current market value, along with weekly movements. | ||
- Support for showing data in different FIAT currencies. | ||
|
||
## Build | ||
|
||
First follow the steps below to install the dependencies: | ||
|
||
Install it with: | ||
```bash | ||
$ npm install -g ionic cordova | ||
$ npm install | ||
$ ionic cordova prepare | ||
``` | ||
|
||
### Use | ||
Run on device: | ||
|
||
To run it on an emulator (accessible as a webpage at `http://localhost:8000`): | ||
```bash | ||
$ ionic cordova emulate browser | ||
$ ionic cordova run ios | ||
$ ionic cordova run android | ||
``` | ||
|
||
Debug in browser: | ||
|
||
```bash | ||
$ npm run ionic:serve | ||
``` | ||
|
||
## Contributing | ||
|
||
- If you find any bugs, submit an [issue](../../issues) or open [pull-request](../../pulls), helping us catch and fix them. | ||
- Engage with other users and developers on [ARK Slack](https://ark.io/slack/). | ||
- Join to our [gitter](https://gitter.im/ark-developers/Lobby). | ||
- [Contribute bounties](./CONTRIBUTING.md). | ||
|
||
## Authors | ||
- Lúcio Rubens <lucio@ark.io> | ||
- Alex Barnsley <alex@ark.io> | ||
|
||
## License | ||
|
||
Ark Mobile is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details. |