docs first attempt
This commit is contained in:
@@ -1,6 +1,24 @@
|
||||
# Spooty
|
||||
### Self-hosted spotify downloader
|
||||
# Spooty - selfhosted Spotify downloader
|
||||
Spooty is a self-hosted Spotify downloader.
|
||||
It allows download track/playlist/album from the spotify url.
|
||||
It can also subscribe to a playlist or author page and download new songs upon release.
|
||||
The project is based on NestJS and Angular.
|
||||
|
||||

|
||||
|
||||
### Content
|
||||
- [🚀 Instalation](#-instalation)
|
||||
- [📚 Documentation](#-documentation)
|
||||
- [📖 License](#-license)
|
||||
|
||||
# 🚀 Instalation
|
||||
Recommended and the easiest way how to start to use of Spooty is using docker.
|
||||
```shell
|
||||
docker run --rm -p 3000:3000 -v /home/raiper34/Hudba:/usr/src/app/spooty-be/dist/downloads spooty-test-1
|
||||
```
|
||||
docker run -d -p 3000:3000 -v /path/to/downloads:/spooty/dist/backend/downloads spooty
|
||||
```
|
||||
|
||||
# 📚 Documentation
|
||||
For more details and complete documentation check: https://spooty.netlify.app/
|
||||
|
||||
# 📖 License
|
||||
MIT
|
||||
Reference in New Issue
Block a user