Browse Source

Merge pull request 'markdown edits to fix numbered lists' (#6) from jahway603/hushchat:master into master

Reviewed-on: #6
master
jahway603 3 years ago
parent
commit
cef50c9046
  1. 11
      README.md
  2. 39
      guide.md

11
README.md

@ -11,7 +11,8 @@
<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">
![Active HushChat between users](images/hushchat-screen.png)
## Features of HushChat:
@ -30,6 +31,10 @@ HushChat is a protocol which is a particular use case of HushList protocol and w
inspired by the design of Signal Protocol and uses many of the same cryptography and ideas, but does not actually use any
code from Signal. A HushChat protocol whitepaper is in progress.
## How do you start using HushChat?
Refer to our [HushChat Beta Guidebook](guide.md) to learn more.
## 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).
@ -74,10 +79,6 @@ In order of development:
The Lite mode desktop version is released in beta and our Android mobile version is in active development.
## How do you start using HushChat?
Refer to our [HushChat Beta Guidebook](guide.md) to learn more.
## What is HushList?
HushList is a protocol first published in 2017, which describes how to use Zcash Protocol for various communications use cases,

39
guide.md

@ -8,60 +8,61 @@ 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.
* **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">
![HushChat garbage text appearing as users did not correctly setup HushChat handshake first](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">
![HushChat tab indicators](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.
2. 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.
3. Bob shares his newly created HushChat z-addr with Alice.
1. Alice receives Bob's HushChat z-addr.
4. 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">
![HushChat "Send Contract Request" screen](images/hushchat-send-contact-request.png)
2. Alice then fills it in as follows:
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
* Choose a nickname
* Enter Bob's HushChat z-addr
* Choose an avatar (custom avatars coming soon)
* Add a custom memo introducing yourself
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">
![HushChat tab indicating contact request waiting](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">
![HushChat "Incoming Contact Request" screen](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">
![HushChat "Incoming Contact Request" screen with user clicking on an open request](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)
* 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">
![HushChat "Added Contact" popup window](images/hushchat-added-contact-popup.png)
##### Now Patience...
@ -73,7 +74,7 @@ Alice and Bob first have to initiate the HushChat initial communication handshak
Now both Alice and Bob are able to type encrypted memos (messages) back and forth and enjoy a bit of privacy :sunglasses:
<img src="images/hushchat-screen.png">
![Active HushChat between users](images/hushchat-screen.png)
## Support

Loading…
Cancel
Save