diff --git a/README.md b/README.md index ca4b549..1059fe1 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,21 @@ -About +![cryptalk](/docs/screenshot.png) + +Cyptalk is a HTML5/Node.js based encrypted instant chat + +Features ======== -Cryptalk is a Node.js based encrypted instant chat + * Client side AES-CBC encryption (the server is just a messenger) + * 265 bit key derived from your passphrase using PBKDF2 + * Optional nicknames + * Random (UUID v4) channel name generation för less guessability + * Quick-links (not recommended) using http://server/#Room:Passphrase + * Super simple setup + * ~~Flashing title on new messages~~ + * ~~Flashing title on new messages~~ -Installation +Setup ======== Install node.js, exact procedure is dependant on platform and distribution. @@ -25,4 +36,4 @@ Start server node server.js ``` -Browse to http://localhost:8080 +Browse to ```http://localhost:8080```