From 71cbe4b0722abe74b20b4d0700eb5a3fb2e2af70 Mon Sep 17 00:00:00 2001 From: Zack Date: Sun, 7 Feb 2016 21:59:35 -0500 Subject: [PATCH] Update README.md Former-commit-id: 5bda6011023478c4d820d5b4a97ff21d4a2a2954 [formerly d9b2633e7fa7b4f75760edbf0315751ed6998f1a] [formerly 29c5196c62337a87680598b54426c6c810093e10 [formerly 7872400c8282dd50bb48c11cb5585020a630944d]] Former-commit-id: 74678d9158507d31cb7fa78ab42654f58a6a441c [formerly 9a468782632bf9d4e12703196ed36692b93d6f8d] Former-commit-id: 3f88bf5d65c587629e4a446ac501ac87645d2425 --- README.md | 21 +++++++++++++++++++-- 1 file changed, 19 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a270b65..822b8ba 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,19 @@ -# cowyo -Websocket notepad +# Cowyo... + +_...is the Collection of Online Words You Open._ + +This tool is supposed to make sharing online notes and lists fast and easy. To jot a note, simply load the page at [`/`](http://cowyo.com/) and write. The url will redirect to an easy-to-remember name that you can use to reload the page at anytime, anywhere. (You can use any url you want too: [`/AnythingYouWant`](http://cowyo.com/AnythingYouWant)). No need to press save, it will automatically save when you stop writing. + +You can also write your notes in [Markdown](https://daringfireball.net/projects/markdown/) and then render your page by adding `/view`. For example, the page `/about` is rendered at [`/about/view`](/about/view). + +If you are writing a list and you want to tick off things really easily, just add `/list`. For example, after editing [`/grocery`](http://cowyo.com/grocery), goto [`/grocery/list`](http://cowyo.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. + +Math is supported using [Katex](https://github.com/Khan/KaTeX). + +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/cowyo). + +**Powered by Raspberry Pi and Go** ![Raspberry Pi](http://cowyo.com/static/img/raspberrypi.png) ![Go Mascot](http://cowyo.com/static/img/gomascot.png) + +# Install + +`go get github.com/schollz/cowyo`