hush-docs/README.md

# Hush Docs

<p align="left">
    <a href="https://twitter.com/MyHushTeam">
        <img src="https://img.shields.io/twitter/url?style=social&url=https%3A%2F%2Ftwitter.com%2Fmyhushteam"
            alt="MyHushTeam's Twitter"></a>
    <a href="https://twitter.com/intent/follow?screen_name=MyHushTeam">
        <img src="https://img.shields.io/twitter/follow/MyHushTeam?style=social&logo=twitter"
            alt="follow on Twitter"></a>
    <a href="https://fosstodon.org/@myhushteam">
        <img src="https://img.shields.io/badge/Mastodon-MyHushTeam-blue"
            alt="follow on Mastodon"></a>
    <a href="http://hush.is/reddit">
        <img src="https://img.shields.io/reddit/subreddit-subscribers/Myhush?style=social"
            alt="MyHushTeam's Reddit"></a>
    <a href="http://hush.is/tg">
        <img src="https://img.shields.io/badge/Telegram-2CA5E0?style=for-the-badge&logo=telegram&logoColor=white" alt="MyHushTeam's Telegram"></a>
</p>

## Hush Documentation

Most people visiting this page will be seeking how to setup their wallets. We also have a section for those interested in running servers and those interested in mining Hush.

### Wallets

![funny money](images/wallet.gif)

If you are looking to setup a Hush wallet, then you have the following two choices:

- [Setup Hush full node wallet with hushd](sd.md)
- [Setup Hush lite wallet featuring HushChat](sdl.md)

As for mobile wallets:
- [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. [We recommend you install this using our custom F-Droid repository here](https://git.hush.is/jahway603/sda-fdroid).
- Hush does not have an iOS app yet, care to make one?

### HushChat 

Currently [HushChat](https://git.hush.is/hush/hushchat) is only available in the Hush lite wallet and it is in beta mode.

If you are interested in testing it, then [please refer to our guide here](https://git.hush.is/hush/hushchat/src/branch/master/guide.md).

#### Miners

![lol doge miners](images/doge-miners.gif)

If you want to mine Hush, then the following documents are for you:

- [Setup your Hush Innosilicon Miner for pool mining](mining/mine-innosilicon.md)
- [Setup your Hush Innosilicon Miner for SOLO mining](mining/solo-mining.md)


#### Translations

See https://git.hush.is/onryo/translate-sd-sdl for detailed documentation on making Hush translations and https://git.hush.is/hush/translations for an overview of how we deal with translations in the Hush community.


#### Servers?

![computer on fire](images/servers.gif)

If you know what you're doing, and want to setup a server to help the Hush community, then the following documents are for you:

- [Setup your own Hush Lite Wallet Server](hush-lite-server.md)
- [Setup your own Hush Seeder Server](https://git.hush.is/hush/hush-seeder) (**Better documentation in progress**)

#### Advanced

![men doing kung-fu](images/hush-kung-fu.gif)

If you need some Hush kung-fu, then you know what to do!!! **This is not for GUI wallet users :)**

- RPC documentation: https://faq.hush.is/rpc/
  - If you use a hush command-line full node, you can look up the docs for every single RPC at the link above
- [SDL in the RAW](advanced/sdl-in-the-raw.md): this howto is to setup an SDL server locally if your system is unable to access any online

## Support Links

- [Hush general Telegram chat](https://hush.is/tg)
- [Hush tech support via Telegram](https://t.me/hush8support)
- [Hush mining support via Telegram](https://t.me/minersgonnamine)

## How to follow Hush

- [Mastodon](https://fosstodon.org/@myhushteam)