Browse Source

add some nice readme docs

master
Jonathan "Duke" Leto 7 years ago
parent
commit
dc8f8a25fe
  1. 28
      README.md
  2. 5
      bin/hushlist

28
README.md

@ -1,4 +1,28 @@
# Hush in Perl
# Hushlist: Censorship Resistant Communication
# create a new Hush contact
hushlist contact add alice z123
hushlist contact add bob z456
# see an overview of your local hushlist infoz
hushlist status
# create a new private hushlist, which exists locally only
# and has no cost associated, since nothing is sent to the blockchain
hushlist new listname
hushlist send
# make an already created private hushlist PUBLIC, i.e.
# publish it's privkey to the blockchain. This costs HUSH, since
# we need to send an xtn to the blockchain
hushlist public listname
hushlist status listname
hushlist add listname alice bob
hushlist send listname "A beginning is the time for taking the most delicate care that the balances are correct."
# send using a non-default chain
hushlist send listname --chain tush "If wishes were fishes, we'd all cast nets."
# donate 5 HUSH to the nice devs who write this software
hushlist donate 5 hush

5
bin/hushlist

@ -32,6 +32,7 @@ my $COMMANDS = {
"remove" => \&remove,
"send" => \&send,
"status" => \&status,
"public" => \&public,
};
run();
exit;
@ -70,6 +71,10 @@ sub status {
}
}
sub public {
my ($name) = @_;
}
sub new {
my $name = shift || '';
#TODO: better validation and allow safe unicode stuff

Loading…
Cancel
Save