added readme

This commit is contained in:
a. fox 2024-02-16 15:50:44 -05:00
parent 135744037b
commit 92b54d04c5
1 changed files with 20 additions and 0 deletions

20
README.md Normal file
View File

@ -0,0 +1,20 @@
# SeanutSwift
A utility to download media from Jellyfin Servers
## Usage
1. First, log in to your server: `$ ./seanut login -d your.jellyfin.server --username TestUser`
2. Search for media: `$ ./seanut search -d your.jellyfin.server "Media Query"`
3. Download media: `$ ./seanut download -d your.jellyfin.server long-media-uuid`
## Building
1. install swift for your system
2. clone this repo
3. `cd` into the directory and run `swift build -c release`
4. if everything was successful run `$(swift build --show-bin-path -c release)/seanut help` for more info
# License
GPLv3+