summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md40
1 files changed, 34 insertions, 6 deletions
diff --git a/README.md b/README.md
index cc94285d..00d0294d 100644
--- a/README.md
+++ b/README.md
@@ -1,18 +1,46 @@
# Invidious
-Alternative frontend for YouTube
+> Invidious is a web application that indexes popular video sites
## 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
+$ crystal deps
+```
+
+### Installing Postgres:
+
+Onn Arch:
+Install according to the [wiki](https://wiki.archlinux.org/index.php/PostgreSQL), then setup database with:
+```bash
+$ ./setup.sh
+```
+On OSX:
+```bash
+$ brew install postgres
+```
+
+## Usage:
+
```bash
-pacman -Syu shards crystal
-crystal deps
+$ crystal src/invidious.cr
```
-## Usage
+Or for development:
```bash
-crystal deps
-./sentry
+$ curl -fsSLo- https://raw.githubusercontent.com/samueleaton/sentry/master/install.cr | crystal eval
+$ ./sentry
```
## Contributing