summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorOmar Roth <omarroth@hotmail.com>2018-03-09 10:48:01 -0600
committerOmar Roth <omarroth@hotmail.com>2018-03-09 10:48:01 -0600
commita7d223a0cfa92c5029692ca945803461231dfcaa (patch)
tree6143d6268132f29a1d69cbfaf131ddd83f65b188
parentd9c89f7e3fef4e159dd5c9f17fc8f809d1ef7a15 (diff)
downloadinvidious-a7d223a0cfa92c5029692ca945803461231dfcaa.tar.gz
invidious-a7d223a0cfa92c5029692ca945803461231dfcaa.tar.bz2
invidious-a7d223a0cfa92c5029692ca945803461231dfcaa.zip
Update README
-rw-r--r--README.md21
1 files 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