aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authormetamuffin <metamuffin@disroot.org>2024-01-25 19:48:13 +0100
committermetamuffin <metamuffin@disroot.org>2024-01-25 19:48:13 +0100
commit4f4f54ec239df336ca4ecc0cae9126452a2f707c (patch)
treee808b3124c4469be28b6b2437f0c1b4113c79dc1
parent9ddd5f242d59b45e9120526012468002b2f654f4 (diff)
downloadjellything-4f4f54ec239df336ca4ecc0cae9126452a2f707c.tar
jellything-4f4f54ec239df336ca4ecc0cae9126452a2f707c.tar.bz2
jellything-4f4f54ec239df336ca4ecc0cae9126452a2f707c.tar.zst
a
-rw-r--r--readme.md21
1 files changed, 3 insertions, 18 deletions
diff --git a/readme.md b/readme.md
index 0238a2a..b12c96b 100644
--- a/readme.md
+++ b/readme.md
@@ -3,8 +3,9 @@
Jellything (not to be confused with "Jellyfin") is a media streaming software,
optimizied for serving movies and such.
-To get started, take a look at
-[the Book](https://jellything.metamuffin.org/book/)
+## Documentation & Guide
+
+See [the Book](https://jellything.metamuffin.org/book/).
## Features
@@ -20,22 +21,6 @@ To get started, take a look at
- Adaptive bitrate and real-time transcoding
- Blazingly fast 🚀 🚀
-## Usage
-
-Requirements:
-
-- esbuild
-- dav1d
-- nasm
-- nightly rust toolchain
-
-```sh
-cargo +nightly install jellything --git https://codeberg.org/metamuffin/jellything.git
-cargo +nightly install jellytool --git https://codeberg.org/metamuffin/jellything.git
-jellytool init --brand 'Blubflix' data # data will be a directory containing all the instances data
-jellything data/config.yaml
-```
-
## Licence
The Licence is AGPL-3.0-only, see `COPYING`