From a7d223a0cfa92c5029692ca945803461231dfcaa Mon Sep 17 00:00:00 2001 From: Omar Roth Date: Fri, 9 Mar 2018 10:48:01 -0600 Subject: [PATCH] Update README --- README.md | 21 +++++++++++++-------- 1 file changed, 13 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 8453adc8..7f0707ac 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,20 @@ # Invidious -> Invidious is a web application that indexes popular video sites +> Invidious is what YouTube should be ## Installation ### Installing [Crystal](https://github.com/crystal-lang/crystal): On Arch: + ```bash $ sudo pacman -Syu shards crystal $ crystal deps ``` On OSX: + ```bash $ brew update $ brew install shards crystal-lang @@ -25,11 +27,13 @@ On Arch: Install according to the [wiki](https://wiki.archlinux.org/index.php/PostgreSQL#Installing_PostgreSQL): On OSX: + ```bash $ brew install postgres ``` -Then setup database with: +Then setup database with + ```bash $ ./setup.sh ``` @@ -41,6 +45,7 @@ $ crystal src/invidious.cr ``` Or for development: + ```bash $ curl -fsSLo- https://raw.githubusercontent.com/samueleaton/sentry/master/install.cr | crystal eval $ ./sentry @@ -48,12 +53,12 @@ $ ./sentry ## Contributing -1. Fork it ( https://github.com/omarroth/invidious/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) -5. Create a new Pull Request +1. Fork it ( https://github.com/omarroth/invidious/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) +5. Create a new Pull Request ## Contributors -- [omarroth](https://github.com/omarroth) - creator, maintainer +* [omarroth](https://github.com/omarroth) - creator, maintainer