diff --git a/README.md b/README.md index aab3c7fb4c..8fae3ae731 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,59 @@

Jellyfin Web

-

The Free Software Media System

+

Part of the Jellyfin Project

---

Logo Banner -

-GPL 2.0 License -Current Release -Translation status +
+
+ +GPL 2.0 License + + +Current Release + + +Translation Status + +
+ +Donate + + +Feature Requests + + +Discuss on our Forum + + +Chat on Matrix + + +Join our Subreddit +

---- +Jellyfin Web is the frontend used for most of the clients available for end users, such as desktop browsers, Android, and iOS. We welcome all contributions and pull requests! If you have a larger feature in mind please open an issue so we can discuss the implementation before you start. Translations can be improved very easily from our Weblate instance. Look through the following graphic to see if your native language could use some work! -Jellyfin is a free software media system that puts you in control of managing and streaming your media. + +Detailed Translation Status + + +## Build Process + +### Dependencies + +- Yarn or NPM + +### Getting Started + +1. Clone or download this repository. + ```sh + git clone https://github.com/jellyfin/jellyfin-web.git + cd jellyfin-web + ``` +2. Install build dependencies in the project directory via npm. + ```sh + npm install + ```