From dac280af51f6ab220ffa51c3147904eee9e94f72 Mon Sep 17 00:00:00 2001 From: Martijn van Dijk Date: Tue, 11 Oct 2016 13:37:30 +0200 Subject: [PATCH] Update README.md --- README.md | 62 ++++++++++++++++++++++++++++++++++++++----------------- 1 file changed, 43 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 8b7d72a1..0d0daeea 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,46 @@ -## Media Plugin for Xamarin and Windows - -Cross platform plugin to play media from shared code. - -### Setup -* Available on NuGet: https://www.nuget.org/packages/Plugin.MediaManager/ -* Install into your PCL project and Client projects. - -**Supports** -* Xamarin.iOS -* Xamarin.Android -* Windows UWP - - -### API Usage - -Call **MediaManager.Current** from any project or PCL to gain access to APIs. - -See Sample for usage. +## MediaManager - Cross platform media plugin for Xamarin and Windows +* Designed to be simple and easy to use +* Stand alone for easy integration with existing projects and frameworks +* Native plackback of media file +* Native notifications and remote controls + +### Setup & Usage +* Available on NuGet: https://www.nuget.org/packages/Plugin.MediaManager/ [![NuGet](https://img.shields.io/nuget/v/Plugin.MediaManager.svg?label=NuGet)](https://www.nuget.org/packages/Plugin.MediaManager/) +* Install into each project that utilizes MediaManager + +### Build Status: [![Build status](https://ci.appveyor.com/api/projects/status/c9c6recwcu7k0s15?svg=true)](https://ci.appveyor.com/project/martijn00/xamarinmediamanager) + +**Platform Support** + +|Platform|Supported|Version| +| ------------------- | :-----------: | :------------------: | +|Xamarin.iOS|Yes|iOS 7+| +|Xamarin.Android|Yes|API 9+| +|Windows Phone Silverlight|No|| +|Windows Phone RT|No|| +|Windows Store RT|No|| +|Windows 10 UWP|Yes|10+| +|Windows WPF|No| +|.Net Framework|Yes|4.5| +|.Net Standard|Future| +|Xamarin.Mac|Yes|| +|Xamarin.tvOS|Yes|| + +### Example Usage + +### Add the NuGet package to your PCL +* In Visual Studio - Tools > NuGet Package Manager > Manage Packages for Solution +* Select the Browse tab, search for MediaManager +* Select Plugin.MediaManager +* Install into each project within your solution + +Call **MediaManager.Current** from any .Net library or Xamarin project to gain access to APIs. + +```csharp +await CrossMediaManager.Current.Play("http://www.montemagno.com/sample.mp3"); +``` + +See Sample for more details. ### **IMPORTANT** **Android:**