Merge pull request #22 from JacobCoffee/feature-100-rework-readme

jcoffee-feature-100-rework-readme

README.md

@@ -2,45 +2,14 @@
 
 Jellyfin integration for Home Assistant
 
-## Changelog
+## Installation:
 
-### 1.0.8
+- Install the Jellyfin integration through HACS or below
+  ![](https://my.home-assistant.io/badges/config_flow_start.svg)
+- Configure your Jellyfin server
+- After a restart, you will have media_player and sensor entities.
 
-- Fix browse service (#21)
+---
-
-### 1.0.7
-
-- Fix error handling
-
-### 1.0.6
-
-- Fix exception when item is not playable
-
-### 1.0.5
-
-- Fix IoT class
-- Fix media play
-
-### 1.0.4
-
-- Fix Playlist folder
-
-### 1.0.3
-
-- Fix cast
-- Info in YAMC
-
-### 1.0.2
-
-- Do not throttle data update
-
-### 1.0.1
-
-- Config flow fixes
-
-### 1.0.0
-
-- Initial public release
 
 ## Features
 
@@ -49,11 +18,11 @@ Jellyfin integration for Home Assistant
 - 1 media_player entity per device
 - 1 sensor per server
 - Supports the "upcoming-media-card" custom card
-  
+
 ### Media Browser
 
 - Browse medias and start playback from within Home Assistant
-  
+
 ### Media Source
 
 - Browse and stream to a cast device (e.g. Chromecast)
@@ -64,3 +33,20 @@ Jellyfin integration for Home Assistant
 - `browse`: Show a media info on a device
 - `delete`: Delete a media
 - `search`: Search for media (for compatible fontends)
+
+### Upcoming Media Card
+
+###### Sample for ui-lovelace.yaml:
+
+```
+- type: custom:upcoming-media-card
+  entity: sensor.jellyfin_media_server
+  title: Latest Media
+```
+
+More configuration options can be found in the [upcoming-media-card](https://github.com/custom-cards/upcoming-media-card#options) repo.
+
+---
+
+#### [View Changelog](changelog/changelog.md)
+

changelog/changelog.md

@@ -0,0 +1,39 @@
+## Changelog
+
+### 1.0.8
+
+- Fix browse service (#21)
+
+### 1.0.7
+
+- Fix error handling
+
+### 1.0.6
+
+- Fix exception when item is not playable
+
+### 1.0.5
+
+- Fix IoT class
+- Fix media play
+
+### 1.0.4
+
+- Fix Playlist folder
+
+### 1.0.3
+
+- Fix cast
+- Info in YAMC
+
+### 1.0.2
+
+- Do not throttle data update
+
+### 1.0.1
+
+- Config flow fixes
+
+### 1.0.0
+
+- Initial public release