main readme

This commit is contained in:
FrenchGithubUser
2025-04-15 21:07:56 +02:00
parent 639ce44d5d
commit 83d7aa310c
10 changed files with 57 additions and 47 deletions

57
README.md Normal file
View File

@@ -0,0 +1,57 @@
# arcadia
<p align="center">
<a href="https://discord.gg/amYWVk7pS3">
<img src="https://img.shields.io/badge/Discord-Chat-5865F2?logo=discord&logoColor=white" alt="Join Our Discord">
</a>
</p>
For contributions see (backend) [backend/CONTRIBUTING.md](backend/CONTRIBUTING.md) (frontend) [frontend/CONTRIBUTING.md](frontend/CONTRIBUTING.md)
## Screenshots
Here are some examples of what type of content can be hosted with Arcadia, and how it can look like.
### Books (ebooks and audiobooks)
![](media/book.png)
### Book series
#### Entry view
![](media/book-illustrated.png)
#### Series view
![](media/book-illustrated-series.png)
### Movies
![](media/movie.png)
### Music
![](media/music.png)
### TV Shows
#### Season entry
![](media/tvshow.png)
#### Series view
![](media/tvshow-series.png)
### Collections
Collections represent a "grouping" of content, to avoid having multiple uploads to do and to limit the load on the tracker. This can be useful for site-dumps, full/finished series, monthly/yearly grouping of content etc.
#### Example with a podcast
![](media/collection-podcast.png)
## Acknlowedgements
- Thanks to [GazellePW](https://github.com/Mosasauroidea/GazellePW/) for their mediainfo and bdinfo parsers written in js