From 2eda66e3dfbe25226b9350caf0c26be37f0fd6d7 Mon Sep 17 00:00:00 2001 From: Alan Norton Date: Fri, 7 Mar 2014 12:19:48 -0500 Subject: [PATCH] updated readme --- README.md | 35 ++++++++++++++++++++++++++++++++--- 1 file changed, 32 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 4e4eaa9..218b30a 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,33 @@ -privnote-cli -============ -the power of privnote.com at your fingertips +# **privnote-cli**: +_the power of [privnote.com](https://privnote.com) in your terminal_ + +#### [privnote.com](https://privnote.com): Send notes that will self-destruct after being read. + +Privnote allows you to create one-time-pad encrypted, burn-after-reading notes over the internet. It's a great way to share passwords or other sensitive peices of information. But, you have to use a web browser! Or, should I say, _had_ to. + +You've got three options when invoking privnote-cli. + +Pass your note as argument(s) + +``` +node privnote-cli.js hi my name is alan +node privnote-cli.js "hello. how are you?" +``` + +Pass your note via stdin + +``` +echo "the rain in spain stays mainly in the plain" | node privnote-cli.js +``` + +Use a here document to pass multiline notes: + +``` +node privnote-cli.js << EOF + + +EOF +``` + +After invocation, the privnote url will be printed at the commandline. If you use the bash wrapper for osx, it will also be copied to your clipboard.