Browse Source

add android app documentation, minor changes to other documents

fullnodevm
jahway603 3 years ago
parent
commit
8d7434b7d3
  1. 2
      README.md
  2. 20
      hushd-desktop-linux.md
  3. 7
      hushd-desktop-windows.md
  4. 2
      sd.md
  5. 26
      sda.md
  6. 3
      sdl.md

2
README.md

@ -29,7 +29,7 @@ If you are looking to setup a Hush wallet, then you have the following two choic
- [Setup Hush lite wallet featuring Hushchat](sdl.md)
As for mobile wallets:
- Hush Android app is a companion app which pairs with either of the above two options.
- [Hush Android app](sda.md) is a companion app which pairs with either of the above two options. A mobile lite wallet is in development.
- Hush does not have an iOS app yet, care to make one?
#### Servers?

20
hushd-desktop-linux.md

@ -6,6 +6,8 @@ In this example, we are using Ubuntu 18.04 (64 bits). This will be different on
### Setup hush user account
I would consider this optional as you can run hushd as your own user account. Creating a separate user account is great for added security and recommended for servers.
1) Log in as user account with sudo access and add a user 'hush' under which the daemon (hushd) will run :
```
@ -19,8 +21,7 @@ In this example, we are using Ubuntu 18.04 (64 bits). This will be different on
$ sudo adduser hush sudo
```
3) Switch to user 'hush'
su - hush
3) Switch to user 'hush': su - hush
4) Update your system
@ -38,8 +39,8 @@ The next step is up to you. I personally like to compile from source and recomme
If you just want to install an "exe" file, run it, and go, then I would recommend trying the binary install.
On Ubuntu 18.04/20.04 (Debian?), try this:
$ wget https://github.com/MyHush/hush3/releases/download/v3.5.2/hush-3.5.2-amd64.deb
$ sudo dpkg -i hush-3.5.2-amd64.deb
- go to [hush3 releases page](https://git.hush.is/hush/hush3/releases) and get latest version
- then install using ```dpkg -i hush-3.x.x-amd64.deb```
#### compile yourself
@ -93,16 +94,7 @@ For Arch Linux, there are [hush3](https://aur.archlinux.org/packages/hush3/) and
rpcallowip=127.0.0.1
rpcbind=127.0.0.1
addressindex=1
spentindex=1
timestampindex=1
showmetrics=1
addnode=explorer.myhush.org
addnode=stilgar.leto.net
addnode=dnsseed.bleuzero.com
addnode=dnsseed.hush.quebec
addnode=199.247.28.148
```
### Now we can start hushd daemon

7
hushd-desktop-windows.md

@ -8,7 +8,7 @@ In this example, we are using Windows 10 (64 bit).
On Windows I suggest you use the release binary unless you know what you're doing regarding code and compilers.
1) Download the [release binary here](https://github.com/MyHush/hush3/releases/) and unextract the zip file.
1) Download the [release binary here](https://git.hush.is/hush/hush3/releases) and unextract the zip file. (Note: for 3.6.0 please choose the larger file)
1) The data (blockchain, configuration, etc.) will be stored in 'C:\Users\<YOUR_USERNAME>/AppData/Roaming/Komodo/HUSH3' (on Windows) by default.
@ -25,10 +25,7 @@ On Windows I suggest you use the release binary unless you know what you're doin
rpcallowip=127.0.0.1
rpcbind=127.0.0.1
addnode=explorer.myhush.org
addnode=stilgar.leto.net
addnode=dnsseed.bleuzero.com
addnode=dnsseed.hush.quebec
addnode=199.247.28.148
```
### Now we can start hushd daemon

2
sd.md

@ -14,5 +14,5 @@ First you want to setup the Hush daemon (hushd). This enables your computer to d
**Make sure you make a paper backup of your seed phrases!**
Pick either the [binary release](https://github.com/MyHush/SilentDragon/releases) or [compile it yourself](https://git.hush.is/hush/SilentDragon/blob/master/README.md). I personally compile but some prefer binaries.
Pick either the [binary release](https://git.hush.is/hush/SilentDragon/releases) or [compile it yourself](https://git.hush.is/hush/SilentDragon/blob/master/README.md). I personally compile but some prefer binaries.

26
sda.md

@ -0,0 +1,26 @@
# Silent Dragon Android
This documentation is how you use [Silent Dragon Android (SDA)](https://git.hush.is/hush/SilentDragonAndroid), which is the Hush companion app to work with your wallet on your computer.
## Setup wallet on your computer
First setup your desktop wallet and choose [Silent Dragon](sd.md) or [Silent Dragon Lite](sdl.md)
## Using SDA
You will need to do the following steps on your computer and phone to use SDA.
##### On the Desktop computer
1. Open [SilentDragon](https://git.hush.is/hush/SilentDragon) or [SillentDragonLite](https://git.hush.is/hush/SilentDragonLite) wallet application.
1. At the top, click on Apps and then click on "Connect mobile app".
##### On the phone
1. Open your [SilentDragonAndroid app](https://git.hush.is/hush/SilentDragonAndroid) and click "Scan QR Code" to scan the code on the computer screen.
1. Now they should be paired.
1. Now you can send and receive Hush on your Android phone.

3
sdl.md

@ -6,8 +6,9 @@ This documentation is how you setup Silent Dragon Lite (SDL), which is the Hush
**Make sure you make a paper backup of your seed phrases!**
- For Binary releases, [the download link is here](https://github.com/MyHush/SilentDragonLite/releases)
- For Binary releases, [the download link is here](https://git.hush.is/hush/SilentDragonLite/releases)
- For source code so you can compile your own, [the link is here](https://git.hush.is/hush/SilentDragonLite)
- For legacy AppImage releases, [the download link is here](https://github.com/MyHush/SilentDragonLite/releases)
## After you install

Loading…
Cancel
Save