From e93896f7a4f6e2a2d3c74cc3fdcceeb575e093c3 Mon Sep 17 00:00:00 2001 From: Joshua Boniface Date: Sun, 6 Jan 2019 01:59:27 -0500 Subject: [PATCH] Update readme to use readthedocs and clean up 1. Replace all Wiki references to Readthedocs.io references 2. Clean up the layout a bit, remove some redundant bits and make "about" bits consistent between Docs and README --- README.md | 49 ++++++++++++++++--------------------------------- 1 file changed, 16 insertions(+), 33 deletions(-) diff --git a/README.md b/README.md index c4133eb9de..dfa8457de1 100644 --- a/README.md +++ b/README.md @@ -1,53 +1,36 @@

Jellyfin

The Free Software Media System

-

-Jellyfin is a free software media system that puts you in control of managing and streaming your media. -

- ------ - -

-Want to get started? Choose from Prebuilt Packages, or Build from Source. -

-

-Want to contribute? Check out our wiki for guidelines. -

- ---

+Logo banner +

GPL 2.0 License Build Status Docker Pull Count -Chat on Matrix +Documentation +Chat on Matrix Join our Subreddit

-For further details, please see [our wiki](https://github.com/jellyfin/jellyfin/wiki). - -To receive the latest updates, please visit [our public chat on Matrix/Riot](https://matrix.to/#/#jellyfin:matrix.org), our [announce chat](https://matrix.to/#/#jellyfin-announce:matrix.org) for release info, and follow us on [Social Media](https://github.com/jellyfin/jellyfin/wiki/Social-Media). - -## About - -The Jellyfin project was started as a result of Emby's decision to take their code closed-source, as well as various philosophical differences with the core developers. Jellyfin seeks to be the free software alternative to Emby and Plex to provide media management and streaming from a dedicated server to end-user devices. - -Jellyfin is descended from Emby 3.5.2, ported to the .NET Core framework, and aims to contain build facilities for every platform. +--- -## Issues and Feature Requests +Jellyfin is a Free Software Media System that puts you in control of managing and streaming your media. It is an alternative to the proprietary Emby and Plex, to provide media from a dedicated server to end-user devices via multiple apps. Jellyfin is descended from Emby's 3.5.2 release and ported to the .NET Core framework to enable full cross-platform support. There are no strings attached, no premium licenses or features, and no hidden agendas: just a team who want to build something better and work together to achieve it. We welcome anyone who is interested in joining us in our quest! +For further details, please see [our documentation page](https://jellyfin.readthedocs.io). To receive the latest updates, get help with Jellyfin, and join the community, please visit [one of our communication channels on Matrix/Riot or social media](https://jellyfin.readthedocs.io/en/latest/user-docs/getting-help). +For more information about the project, please see our [about page](https://jellyfin.readthedocs.io/en/latest/about/).

- New idea or improvement? -Open a Feature Request. +Want to get started? +Choose from Prebuilt Packages or Build from Source, then see our Quickstart guide.

- Something not working right? -Open an Issue. +Want to contribute? +Check out our documentation for guidelines. +

+

+New idea or improvement? Something not working right? +Open an Issue.

- - -## Contributing to Jellyfin - -If you're interested in contributing, please see [our wiki for guidelines](https://github.com/jellyfin/jellyfin/wiki/Contributing-to-Jellyfin).