aboutsummaryrefslogtreecommitdiff
path: root/readme.md
diff options
context:
space:
mode:
authormetamuffin <metamuffin@disroot.org>2023-09-06 15:22:38 +0200
committermetamuffin <metamuffin@disroot.org>2023-09-06 15:22:38 +0200
commit185ac499ba46ff02c2ceee48ef2b467c469bc783 (patch)
treec3b4c720c5ebf3fb5f7e527070f6501f0b264d3f /readme.md
parent2ceff639ceca3961e644e5291b654107409d298f (diff)
downloadjellything-185ac499ba46ff02c2ceee48ef2b467c469bc783.tar
jellything-185ac499ba46ff02c2ceee48ef2b467c469bc783.tar.bz2
jellything-185ac499ba46ff02c2ceee48ef2b467c469bc783.tar.zst
outline installation and setup in readme
Diffstat (limited to 'readme.md')
-rw-r--r--readme.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/readme.md b/readme.md
index 0abbe67..5e690b2 100644
--- a/readme.md
+++ b/readme.md
@@ -9,6 +9,16 @@ optimizied for serving movies and such.
- Remuxing media on-the-fly to avoid downloading unneccesary tracks.
- Blazingly fast 🚀 🚀
+## Usage
+
+```sh
+rustup install nightly
+cargo +nightly install jellything --git https://codeberg.org/metamuffin/jellything.git
+cargo +nightly install jellything-import --git https://codeberg.org/metamuffin/jellything.git
+jellything-import init --brand 'Blubflix' data # data will be a directory containing all the instances data
+jellything data/config.json
+```
+
## Licence
The Licence is AGPL-3.0-only, see `COPYING`