Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
alfg committed May 13, 2013
1 parent 4e564c8 commit c9c1037
Showing 1 changed file with 17 additions and 4 deletions.
21 changes: 17 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,25 @@
Jot
=======

A simple note-taking and sharing app.
A server-less pastebin-esque note-taking app.

**Demo**: https://alfg.github.com/jot

### Features
* A simple, elegant design
* Data is base64 encoded into the URL hash, so no data is stored.
* Retains formatting of messages
* Data is base64 encoded into the URL hash, so no data is stored on a server
* Easy to share via encoded URL
* Simple to deploy. Just a few static files.
* Encryption support via Blowfish
* Add a secret key with encryption support via Blowfish

**Demo**: https://alfg.github.com/jot
### Notes
* Most modern browsers limit the URL to 2000 characters. Messages can easily generate a long URL depending
on the content. So it is best to keep messages minimal (TODO lists, short snippets of code, etc...).
* Use a URL shortening service to shorten the URL when sharing. Jot URLs can typically be very long
depending on the content.

### Examples
https://alfg.co/jot/#eTWF5IHRoZSBzb3VyY2UgYmUgd2l0aCB5b3Uu
https://alfg.co/jot/#eVGhlIGtleSB0byBoYXBwaW5lc3M6CgoqIEVhdAoqIFNsZWVwCiogQ29kZQ==
https://alfg.co/jot/#bB2011105CADDE78137C738395E17FCDCFED77C945C3B7EA3 (key is foobar)

0 comments on commit c9c1037

Please sign in to comment.