From 4db268455983425f8c7e2f4f9e3daa081711c0c2 Mon Sep 17 00:00:00 2001 From: jahway603 Date: Fri, 29 Jan 2021 17:41:40 -0500 Subject: [PATCH 1/2] changed images from HTML format to markdown format --- README.md | 2 +- guide.md | 16 ++++++++-------- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index b18a1d3..d18864a 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ MyHushTeam's Reddit

- +![Active HushChat between users](images/hushchat-screen.png) ## Features of HushChat: diff --git a/guide.md b/guide.md index 3aec7ef..d635d12 100644 --- a/guide.md +++ b/guide.md @@ -15,13 +15,13 @@ to wait for 1 confirmation every time, before sending. 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: - +![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. - +![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. @@ -33,7 +33,7 @@ Alice and Bob first have to initiate the HushChat initial communication handshak 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: - +![HushChat "Send Contract Request" screen](images/hushchat-send-contact-request.png) 1. Alice then fills it in as follows: * Choose a nickname @@ -45,15 +45,15 @@ Alice and Bob first have to initiate the HushChat initial communication handshak ##### Bob confirms new HushChat contact - +![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: - +![HushChat "Incoming Contact Request" screen](images/hushchat-incoming-contact-request.png) 1. Bob then clicks on the request as seen here: - +![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 @@ -61,7 +61,7 @@ Alice and Bob first have to initiate the HushChat initial communication handshak 1. Bob then clicks "Add new contact" and sees the following "Added Contact" popup, which he clicks "OK" on. - +![HushChat "Added Contact" popup window](images/hushchat-added-contact-popup.png) ##### Now Patience... @@ -73,7 +73,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: - +![Active HushChat between users](images/hushchat-screen.png) ## Support From a14c88d1ff1ee540a1ffddb132a98e4a89f18285 Mon Sep 17 00:00:00 2001 From: jahway603 Date: Fri, 29 Jan 2021 17:56:11 -0500 Subject: [PATCH 2/2] markdown edits to fix numbered lists --- README.md | 9 +++++---- guide.md | 33 +++++++++++++++++---------------- 2 files changed, 22 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index d18864a..4e5cd2d 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,7 @@ MyHushTeam's Reddit

+ ![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, diff --git a/guide.md b/guide.md index d635d12..838a0d1 100644 --- a/guide.md +++ b/guide.md @@ -8,7 +8,6 @@ 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 @@ -21,25 +20,26 @@ Alice and Bob first have to initiate the HushChat initial communication handshak 1. Alice asks Bob for a HushChat z-address (z-addr) to start communicating. -![HushChat tab indicators](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: -![HushChat "Send Contract Request" screen](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). @@ -49,19 +49,20 @@ Alice and Bob first have to initiate the HushChat initial communication handshak 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: -![HushChat "Incoming Contact Request" screen](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: -![HushChat "Incoming Contact Request" screen with user clicking on an open request](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. -![HushChat "Added Contact" popup window](images/hushchat-added-contact-popup.png) + ![HushChat "Added Contact" popup window](images/hushchat-added-contact-popup.png) ##### Now Patience...