From 8f383e072ce8a1d131305a9ceddfe5e60dd7f3fb Mon Sep 17 00:00:00 2001 From: Zack Scholl Date: Mon, 14 Mar 2016 11:26:23 -0400 Subject: [PATCH] Updated Former-commit-id: f9d735e264523a6ffe0bf8244165c9c7135bd887 [formerly 0e5a3cb35a4b0c561a7d4c6175992f96612389bb] [formerly 39f294620a898be4236f0d857dfceb0fe29d634d [formerly 2926bc623cbf39107f7359e4ecf828134ba0bde6]] Former-commit-id: 642f9bb7ae80811899a7424893171c97a42ef417 [formerly c919605caae0c76df1cb76e178e22a5c8cbc1011] Former-commit-id: ce7ed1fbf7889d2fc8f2a13c3cfa7ffe527e1673 --- README.md | 19 +++++++++++++++---- static/img/Main7.gif.REMOVED.git-id | 1 + 2 files changed, 16 insertions(+), 4 deletions(-) create mode 100644 static/img/Main7.gif.REMOVED.git-id diff --git a/README.md b/README.md index d04fc90..29e0cc0 100644 --- a/README.md +++ b/README.md @@ -9,21 +9,32 @@ This is a self-contained wiki webserver that makes sharing easy and _fast_. You # Features **Simplicity**. The philosophy here is to *just type*. To jot a note, simply load the page at [`/`](http://AwwKoala.com/) and just start typing. No need to press edit, the browser will already be focused on the text. No need to press save - it will automatically save when you stop writing. The URL at [`/`](http://AwwKoala.com/) will redirect to an easy-to-remember name that you can use to reload the page at anytime, anywhere. But, you can also use any URL you want, e.g. [`/AnythingYouWant`](http://AwwKoala.com/AnythingYouWant). -![Simply type to edit.](/img/static/Main1.gif) - **Viewing**. All pages can be rendered into HTML by adding `/view`. For example, the page [`/AnythingYouWant`](http://AwwKoala.com/AnythingYouWant) is rendered at [`/AnythingYouWant/view`](http://AwwKoala.com/AnythingYouWant/view). You can write in HTML or [Markdown](https://daringfireball.net/projects/markdown/) for page rendering. To quickly link to `/view` pages, just use `[[AnythingYouWnat]]`. Math is supported with [Katex](https://github.com/Khan/KaTeX) using `$\frac{1}{2}$` for inline equations and `$$\frac{1}{2}$$` for regular equations. +![Simply type to edit.](https://raw.githubusercontent.com/schollz/awwkoala/master/static/img/Main1.gif) + **Listifying**. If you are writing a list and you want to tick off things really easily, just add `/list`. For example, after editing [`/grocery`](http://AwwKoala.com/grocery), goto [`/grocery/list`](http://AwwKoala.com/grocery/list). In this page, whatever you click on will be struck through and moved to the end. This is helpful if you write a grocery list and then want to easily delete things from it. +![Lists are easy to make.](https://raw.githubusercontent.com/schollz/awwkoala/master/static/img/Main3.gif) + **Automatic versioning**. All previous versions of all notes are stored and can be accessed by adding `?version=X` onto `/view` or `/edit`. If you are on the `/view` or `/edit` pages the menu below will show the most substantial changes in the history. Note, only the _current_ version can be edited (no branching allowed, yet). -**Security**. HTTPS support is provided and everything is sanitized to prevent XSS attacks. Though all URLs are publicly accessible, you are free to obfuscate your website by using an obscure/random address (read: the site is still publicly accessible, just hard to find!). The automatic URL is an alliterative animal description - of which there are over 500,000 possibilities - so the URL is easy to remember and hard to guess. +![Versioning is easy.](https://raw.githubusercontent.com/schollz/awwkoala/master/static/img/Main2.gif) + +**Self-destructing messages**. You can write a message that will delete itself when a user loads it (in any view). Useful for transmitting sensitive information. To use, simply add a line somewhere that says only "`self-destruct`". + +![Simply type to edit.](https://raw.githubusercontent.com/schollz/awwkoala/master/static/img/Main4.gif) + +**PGP encryption**. In addition to TLS support, you can PGP-encrypt your messages using a passphrase. + +![Simply type to edit.](https://raw.githubusercontent.com/schollz/awwkoala/master/static/img/Main7.gif) **Keyboard Shortcuts**. Quickly transition between Edit/View/List by using `Ctl+Shift+E` to Edit, `Ctl+Shift+Z` to View, and `Ctl+Shift+L` to Listify. **Admin controls**. The Admin can view/delete all the documents by setting the `-a YourAdminKey` when starting the program. Then the admin has access to the `/ls/YourAdminKey` to view and delete any of the pages. -**Self-destructing messages**. You can write a message that will delete itself when a user loads it (in any view). Useful for transmitting sensitive information. To use, simply add a line somewhere that says only "`self-destruct`". +**Security**. HTTPS support is provided and everything is sanitized to prevent XSS attacks. Though all URLs are publicly accessible, you are free to obfuscate your website by using an obscure/random address (read: the site is still publicly accessible, just hard to find!). The automatic URL is an alliterative animal description - of which there are over 500,000 possibilities - so the URL is easy to remember and hard to guess. + # Install diff --git a/static/img/Main7.gif.REMOVED.git-id b/static/img/Main7.gif.REMOVED.git-id new file mode 100644 index 0000000..9f82bf4 --- /dev/null +++ b/static/img/Main7.gif.REMOVED.git-id @@ -0,0 +1 @@ +2a331627a6afd0f05e00ea4eb56f58904a8168a7 \ No newline at end of file