Original HUSH source code based on ZEC 1.0.8 . For historical purposes only! https://hush.is
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

73 lines
2.3 KiB

# HUSH 2.0.0
## What is HUSH?
![Logo](doc/hush/hush.png "Logo")
6 years ago
HUSH (formerly Zdash) is a code fork of [ZCash](https://z.cash/) which has it's own genesis block.
Based on Bitcoin's code, it intends to offer a far higher standard of privacy
8 years ago
through a sophisticated zero-knowledge proving scheme that preserves
confidentiality of transaction metadata.
This software is the HUSH node and command-line client. It downloads and stores the entire history
of HUSH transactions; depending on the speed of your computer and network
connection, the synchronization process could take a day or more once the
blockchain has reached a significant size.
**HUSH is unfinished and highly experimental.** Use at your own risk!
8 years ago
## NOTE
This is the old/original source code repo for Hush and you almost certaintly want to be looking at https://git.hush.is/hush/hush3 instead, unless you are a code historian.
8 years ago
## Telegram
Please feel free to join us on Telegram at https://www.hush.is/telegram/
There are many channels, some you might enjoy are [#general](https://www.hush.is/telegram/), [#support](https://t.me/hush8support) and [#mining](https://t.me/minersgonnamine).
Installing
----------
8 years ago
See [INSTALL.md](https://git.hush.is/hush/hush/src/branch/master/INSTALL.md).
7 years ago
-----------------
**Hush is experimental and a work-in-progress.** Use at your own risk. Just like Bitcoin.
Testnet
-----------------
https://git.hush.is/hush/hush/src/branch/master/Testnet.md
Secure Setup
-----------------
https://git.hush.is/hush/hush/src/branch/master/SECURE_SETUP.md
Deprecation Policy
------------------
This release is considered deprecated 16 weeks after the release day. There
is an automatic deprecation shutdown feature which will halt the node some
time after this 52 week time period. The automatic feature is based on block
height and can be explicitly disabled.
Where do I begin?
-----------------
As a reference a guide for joining the main Zcash network may be used:
https://github.com/zcash/zcash/wiki/1.0-User-Guide#using-zcash
Users should *not* follow this guide blindly since it applies to ZCash instead of HUSH!
The section of using the command line is relevant to HUSH.
### Need Help?
* See the documentation at the [Hush docs repo](https://git.hush.is/hush/docs)
for help and more general information.
License
-------
For license information see the file [COPYING](COPYING).