diff --git a/README.md b/README.md new file mode 100644 index 00000000..86339658 --- /dev/null +++ b/README.md @@ -0,0 +1,57 @@ +# arcadia + +

+ + Join Our Discord + +

+ +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 diff --git a/frontend/README.md b/frontend/README.md index 76a038a9..5eb067c0 100644 --- a/frontend/README.md +++ b/frontend/README.md @@ -10,50 +10,3 @@ This is the client (frontend) of the Arcadia project. For contributions see [CONTRIBUTING.md](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 diff --git a/frontend/media/book-illustrated-series.png b/media/book-illustrated-series.png similarity index 100% rename from frontend/media/book-illustrated-series.png rename to media/book-illustrated-series.png diff --git a/frontend/media/book-illustrated.png b/media/book-illustrated.png similarity index 100% rename from frontend/media/book-illustrated.png rename to media/book-illustrated.png diff --git a/frontend/media/book.png b/media/book.png similarity index 100% rename from frontend/media/book.png rename to media/book.png diff --git a/frontend/media/collection-podcast.png b/media/collection-podcast.png similarity index 100% rename from frontend/media/collection-podcast.png rename to media/collection-podcast.png diff --git a/frontend/media/movie.png b/media/movie.png similarity index 100% rename from frontend/media/movie.png rename to media/movie.png diff --git a/frontend/media/music.png b/media/music.png similarity index 100% rename from frontend/media/music.png rename to media/music.png diff --git a/frontend/media/tvshow-series.png b/media/tvshow-series.png similarity index 100% rename from frontend/media/tvshow-series.png rename to media/tvshow-series.png diff --git a/frontend/media/tvshow.png b/media/tvshow.png similarity index 100% rename from frontend/media/tvshow.png rename to media/tvshow.png