Added more info on the README
This commit is contained in:
parent
277a4bf138
commit
521c52d235
12
README.org
12
README.org
@ -2,6 +2,8 @@
|
|||||||
|
|
||||||
This is a highly opinionated media server.
|
This is a highly opinionated media server.
|
||||||
|
|
||||||
|
Website: https://yams.media/
|
||||||
|
|
||||||
* Description
|
* Description
|
||||||
:PROPERTIES:
|
:PROPERTIES:
|
||||||
:ID: 280135a0-2cff-4e93-8679-7d1a6d56b7b2
|
:ID: 280135a0-2cff-4e93-8679-7d1a6d56b7b2
|
||||||
@ -71,7 +73,7 @@ $ ./install.sh
|
|||||||
And follow the instructions.
|
And follow the instructions.
|
||||||
|
|
||||||
|
|
||||||
So far, I've tested this in Debian 11, but it should work on Ubuntu as well.
|
So far, I've tested this in Debian 11 and Ubuntu 22.04.
|
||||||
|
|
||||||
* Usage
|
* Usage
|
||||||
:PROPERTIES:
|
:PROPERTIES:
|
||||||
@ -82,7 +84,7 @@ When the script finishes installing without issues, just run:
|
|||||||
$ yams
|
$ yams
|
||||||
yams - Yet Another Media Server
|
yams - Yet Another Media Server
|
||||||
|
|
||||||
Usage: yams [--help|restart|stop|start|status]
|
Usage: yams [--help|restart|stop|start]
|
||||||
options:
|
options:
|
||||||
--help displays this help message
|
--help displays this help message
|
||||||
restart restarts yams services
|
restart restarts yams services
|
||||||
@ -90,6 +92,12 @@ stop stops all yams services
|
|||||||
start starts yams services
|
start starts yams services
|
||||||
destroy destroy yams services so you can start from scratch
|
destroy destroy yams services so you can start from scratch
|
||||||
#+end_src
|
#+end_src
|
||||||
|
* How to configure?
|
||||||
|
:PROPERTIES:
|
||||||
|
:ID: 242b8dfa-82ab-4d86-b3ea-0a0af6cf3ad5
|
||||||
|
:END:
|
||||||
|
|
||||||
|
Go to https://yams.media/config/ and follow the config instructions
|
||||||
|
|
||||||
* Donations
|
* Donations
|
||||||
:PROPERTIES:
|
:PROPERTIES:
|
||||||
|
Loading…
x
Reference in New Issue
Block a user