From 131b92b381cf66a9c7a3a83e04ce685419abdd3d Mon Sep 17 00:00:00 2001 From: Omar Roth Date: Thu, 23 Nov 2017 01:52:37 -0600 Subject: [PATCH] Update readme --- README.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 0cccc7f9..f9577869 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,22 @@ # visor -TODO: Write a description here +Alternative frontend for YouTube ## Installation -TODO: Write installation instructions here +```bash +pacman -Syu shards crystal +crystal deps +``` ## Usage - -TODO: Write usage instructions here - -## Development - -TODO: Write development instructions here +```bash +crystal run src/visor.cr +``` ## Contributing -1. Fork it ( https://github.com/[your-github-name]/visor/fork ) +1. Fork it ( https://github.com/omarroth/visor/fork ) 2. Create your feature branch (git checkout -b my-new-feature) 3. Commit your changes (git commit -am 'Add some feature') 4. Push to the branch (git push origin my-new-feature) @@ -24,4 +24,4 @@ TODO: Write development instructions here ## Contributors -- [[your-github-name]](https://github.com/[your-github-name]) Omar Roth - creator, maintainer +- [omarroth](https://github.com/omarroth) - creator, maintainer