Browse Source

Merge pull request 'updated HushChat guide with better instructions and screenshots' (#5) from jahway603/hushchat:master into master

Reviewed-on: #5
master
jahway603 1 month ago
parent
commit
3993b4b317
11 changed files with 80 additions and 24 deletions
  1. +15
    -6
      README.md
  2. +65
    -18
      guide.md
  3. BIN
      hushchat-sneak-preview.png
  4. BIN
      images/hushchat-added-contact-popup.png
  5. BIN
      images/hushchat-contact-confirm-waiting.png
  6. BIN
      images/hushchat-garbage.png
  7. BIN
      images/hushchat-incoming-contact-request-2.png
  8. BIN
      images/hushchat-incoming-contact-request.png
  9. +0
    -0
      images/hushchat-screen.png
  10. BIN
      images/hushchat-send-contact-request.png
  11. BIN
      images/hushchat-tab-indicators.png

+ 15
- 6
README.md

@ -1,6 +1,17 @@
# HushChat - Signal-like Protocol on Hush
<img src="hushchat-screen.png">
<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="https://www.reddit.com/r/Myhush/">
<img src="https://img.shields.io/reddit/subreddit-subscribers/Myhush?style=social" alt="MyHushTeam's Reddit"></a>
</p>
<img src="images/hushchat-screen.png">
## Features of HushChat:
@ -21,9 +32,7 @@ code from Signal. A HushChat protocol whitepaper is in progress.
## Is HushChat only compatible with HUSH mainnet?
No, it's designed to run on any compatible Zcash Protocol chain, including all Hush Smart Chains:
https://git.hush.is/hush/hush-smart-chains
No, it's designed to run on any compatible Zcash Protocol chain, including all [Hush Smart Chains](https://git.hush.is/hush/hush-smart-chains).
That being said, HushChat is being developed soley on HUSH mainnet. Other cryptocoins are encouraged to read our Free Software and port it to their codebases with appropriate licensing.
@ -80,7 +89,7 @@ communicaitons. The world is increasingly chat-based versus email-based and Hush
## Will HushChat store messages on the blockchain like HushList does?
Yes, data must be stored on-chain to have censorship resistance and HushChat can be thought of as a "flavor" of HushList.
Users may choose between storing data on the *public* Hush blockchain or their own Hush Smart Chain (which could be public or completely private) : https://git.hush.is/hush/hush-smart-chains
Users may choose between storing data on the *public* Hush blockchain or their own [Hush Smart Chain](https://git.hush.is/hush/hush-smart-chains) (which could be public or completely private).
## Isn't it a bad idea to store private data in a blockchain?
@ -126,4 +135,4 @@ Glad you asked!! HushChat adds various layers of privacy on top of our "base" Hu
## Where can I learn more?
Join our [Telegram](https://hush.is/telegram)
Join us on [Telegram](https://hush.is/telegram) or our [Telegram Support](https://hush.is/telegram_support) channels.

+ 65
- 18
guide.md

@ -1,33 +1,80 @@
# HushChat Beta Guide
## Ask somebody for their HushChat z-address (z-addr)
## Initial Setup
They click the button that says "zs1" and it will copy it to their clipboard. Give every contact a different z-addr!
In our example we use HushChat user Alice and HushChat user Bob that **both have valid positive Hush values in their wallets**.
## When you know a HushChat z-addr, send a contact request
Make sure you have funds! Send yourself funds 3+ times or with 3+ outputs in one transaction, so you have multiple
Tips:
* Make sure to send yourself funds 3+ times or with 3+ outputs in one transaction, so you have multiple
"notes" to spend. This means you can send another memo before waiting for a confirmation. If you don't, you will need
to wait for 1 confirmation every time, before sending.
Click the "add contact" button at the top left, and "Send Contact Request" screen will show up.
* Choose a name
* Enter zaddr
* **I cannot stress this enough, but make sure to give every contact a different z-addr (z-address)!**
### HushChat handshake
Alice and Bob first have to initiate the HushChat initial communication handshake otherwise HushChat will not work correctly and you will end up with garbage, like this:
<img src="images/hushchat-garbage.png">
##### Alice begins...
1. Alice asks Bob for a HushChat z-address (z-addr) to start communicating.
<img src="images/hushchat-tab-indicators.png">
1. Bob clicks on the "Zs1" button in his HushChat tab. The result is that the wallet creates a new z-addr and copies it into his clipboard. We'll call this Bob's HushChat z-addr.
1. Bob shares his newly created HushChat z-addr with Alice.
1. Alice receives Bob's HushChat z-addr.
##### Alice adds Bob as HushChat contact
1. Alice clicks on the "add contact" button in her HushChat tab, which is to the left of "Zs1". The result is the "Send Contact Request" screen appears with a new z-addr, which we'll call this Alice's HushChat z-addr. This screen appears as:
<img src="images/hushchat-send-contact-request.png">
1. Alice then fills it in as follows:
* Choose a nickname
* Enter Bob's HushChat z-addr
* Choose an avatar (custom avatars coming soon)
* Add a custom memo introducing yourself
* Click "create new address" to make a custom new zaddr for this contact
* Click "Add contact and send request"
* Close "send contact request" window (this will autoclose in the future)
## If you sent a request, be patient!
It may take a few minutes. This process became twice as fast as of November 2020 at Block 340,000, when our block time
decreased to 75 seconds.
1. Alice then clicks "Add contact and send request" and then close "send contact request" window (this will autoclose in the future).
##### Bob confirms new HushChat contact
<img src="images/hushchat-contact-confirm-waiting.png">
1. Bob clicks on the "incoming contact request" button in his HushChat tab, which is to the left of the "add contact" button. Note that Bob sees a red 1 here instead of the zero, as seen above. The result is the "Incoming Contact Request" screen, which is shown here:
<img src="images/hushchat-incoming-contact-request.png">
1. Bob then clicks on the request as seen here:
<img src="images/hushchat-incoming-contact-request-2.png">
1. Bob then fills it in as follows:
* Choose a nickname
* Choose an avatar (custom avatars coming soon)
1. Bob then clicks "Add new contact" and sees the following "Added Contact" popup, which he clicks "OK" on.
<img src="images/hushchat-added-contact-popup.png">
##### Now Patience...
1. Now Bob sends a HushChat message to Alice. It may take a few minutes. This process became twice as fast as of November 2020 at Block 340,000, when our block time decreased to 75 seconds.
1. Alice then responds once she receives Bob's message.
### Success
## Once your contact has accepted
Now both Alice and Bob are able to type encrypted memos (messages) back and forth and enjoy a bit of privacy :sunglasses:
And you get a response, now you can type encrypted memos back and forth and enjoy a bit of privacy :sunglasses:
<img src="images/hushchat-screen.png">
## Support
Join our [Telegram](https://hush.is/telegram)
Join us on [Telegram](https://hush.is/telegram) or our [Telegram Support](https://hush.is/telegram_support) channels.

BIN
hushchat-sneak-preview.png

Before After
Width: 1076  |  Height: 725  |  Size: 75 KiB

BIN
images/hushchat-added-contact-popup.png

Before After
Width: 506  |  Height: 153  |  Size: 5.5 KiB

BIN
images/hushchat-contact-confirm-waiting.png

Before After
Width: 329  |  Height: 200  |  Size: 9.2 KiB

BIN
images/hushchat-garbage.png

Before After
Width: 726  |  Height: 170  |  Size: 14 KiB

BIN
images/hushchat-incoming-contact-request-2.png

Before After
Width: 780  |  Height: 545  |  Size: 40 KiB

BIN
images/hushchat-incoming-contact-request.png

Before After
Width: 775  |  Height: 541  |  Size: 31 KiB

hushchat-screen.png → images/hushchat-screen.png


BIN
images/hushchat-send-contact-request.png

Before After
Width: 785  |  Height: 382  |  Size: 37 KiB

BIN
images/hushchat-tab-indicators.png

Before After
Width: 328  |  Height: 193  |  Size: 16 KiB

Loading…
Cancel
Save