Updated readme

Former-commit-id: f568dfd0201b4af4a184e687f68b459229c9250c [formerly 4f8e8490d9c21d4e37117ceb6277b7b466209a4d] [formerly 783a2a5198b82d295513dd40f5b8a3a26bc81b33 [formerly a149835056d80bf38ac02ed5c8f6e1d8f5e23818 [formerly e35d528311]]]
Former-commit-id: 52dde48113476ed8e716562dc7089adbc814b3ed [formerly 29c346c4ed72649f7e98897b4b08d97a8fe1fa67]
Former-commit-id: d49500c0b63c114c6688ab10ce33e7cf55c77cc3
Former-commit-id: 8842a0644d

README.md

@@ -2,39 +2,22 @@
 
 # AwwKoala
 ## A Websocket Wiki and Kind Of A List Application
-[![Version 1.0](https://img.shields.io/badge/version-1.0-brightgreen.svg)]()
+[![Version 1.0](https://img.shields.io/badge/version-1.0-brightgreen.svg)]() [![Go Report Card](https://goreportcard.com/badge/github.com/schollz/AwwKoala)](https://goreportcard.com/report/github.com/schollz/AwwKoala) [![Join the chat at https://gitter.im/schollz/AwwKoala](https://badges.gitter.im/schollz/AwwKoala.svg)](https://gitter.im/schollz/AwwKoala?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
-[![Go Report Card](https://goreportcard.com/badge/github.com/schollz/AwwKoala)](https://goreportcard.com/report/github.com/schollz/AwwKoala)
-[![Join the chat at https://gitter.im/schollz/AwwKoala](https://badges.gitter.im/schollz/AwwKoala.svg)](https://gitter.im/schollz/AwwKoala?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
-This is a self-contained wiki webserver that makes sharing easy and *fast*. You can make any page you want, and any page is editable by anyone. Pages load instantly for editing, and have special rendering for whether you want to view as a web page or view as list.
+This is a self-contained wiki webserver that makes sharing easy and _fast_. You can make any page you want, and any page is editable by anyone. Pages load instantly for editing, and have special rendering for whether you want to view as a web page or view as list.
-
-Features:
-- Single file database (BoltDB)
-- No clicking to  edit and save. Just type.
-- Lightweight (~2MB memory)
-- Fast (written in Go)
-
-#### Basics
 
+# Features
+## 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).
 
-#### Views and Lists
+## Views
-
 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. Math is supported with [Katex](https://github.com/Khan/KaTeX) using `$\frac{1}{2}$` for inline equations and `$$\frac{1}{2}$$` for regular equations.
 
+## Lists
 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 striked through and moved to the end. This is helpful if you write a grocery list and then want to easily delete things from it.
 
-#### Versioning
+## 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).
-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).
-
-#### Disclaimer
-
-Be cautious about writing sensitive information in the notes as anyone with the URL has access to it. For more information, or if you'd like to edit the code, [use the github](https://github.com/schollz/AwwKoala).
-
-### Contact
-
-If you'd like help or find a bug, please submit [an issue](https://github.com/schollz/AwwKoala/issues). Any other comments, quetions or anything at all, just <a href="https://twitter.com/intent/tweet?screen_name=zack_118" class="twitter-mention-button" data-related="zack_118">tweet me @zack_118</a>
 
 # Install
 To get started on your local network just do:
@@ -54,7 +37,7 @@ I recommend using `NGINX` as middleware, as it will do caching of the static fil
 ```
 git clone https://github.com/schollz/awwkoala.git
 cd awwkoala
-nano Makefile <--- EDIT Makefile to include YOUR EXTERNAL ADDRESS
+nano Makefile <--- EDIT this Makefile to include YOUR EXTERNAL ADDRESS
 make && sudo make install
 ```
 
@@ -96,6 +79,10 @@ Options:
         port to bind (default ":12312")
 ```
 
-```
-
 If you set the admin flag, `-a` you can access a list of all the current files by going to `/ls/WhateverYouSetTheFlagTo`.
+
+# Contact
+If you'd like help, go ahead and clone and send a pull request. If you find a bug, please submit [an issue](https://github.com/schollz/AwwKoala/issues). Any other comments, questions or anything at all, just <a href="https://twitter.com/intent/tweet?screen_name=zack_118" class="twitter-mention-button" data-related="zack_118">tweet me @zack_118</a>
+
+# Contributors
+Thanks to [tscholl2](https://github.com/tscholl2).