diff --git a/Xamarin.Essentials.sln b/Xamarin.Essentials.sln index 5179e0ec5..13dd3efc0 100644 --- a/Xamarin.Essentials.sln +++ b/Xamarin.Essentials.sln @@ -8,6 +8,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution .editorconfig = .editorconfig .gitignore = .gitignore LICENSE = LICENSE + nugetreadme.txt = nugetreadme.txt README.md = README.md stylecop.json = stylecop.json Xamarin.Essentials.ruleset = Xamarin.Essentials.ruleset diff --git a/Xamarin.Essentials/Xamarin.Essentials.csproj b/Xamarin.Essentials/Xamarin.Essentials.csproj index af7ba3476..e39cff4f1 100644 --- a/Xamarin.Essentials/Xamarin.Essentials.csproj +++ b/Xamarin.Essentials/Xamarin.Essentials.csproj @@ -44,8 +44,9 @@ pdbonly + - + diff --git a/nugetreadme.txt b/nugetreadme.txt new file mode 100644 index 000000000..3b8e6c199 --- /dev/null +++ b/nugetreadme.txt @@ -0,0 +1,44 @@ +## Xamarin.Essentials + +Thank you for installing Xamarin.Essentials, be sure to read through our full documentation at: +http://aka.ms/xamarinessentials + +## Setup + +Ensure that you install Xamarin.Essentials into all of your projects. + +For Android projects there is a small amount of setup needed to handle permissions. Please follow our short guide at: +http://aka.ms/essentials-getstarted + + +## Changes for 0.9.0-preview + +If you are upgrading from an earlier version there are a few changes to the API that may affect your code: + +* SensorSpeed.Ui is now SensorSpeed.UI +* BatteryPowerSource.Ac is now BatteryPowerSource.AC +* Change to generic EventHandlers for Accelerometer, Battery, Compass, Connectivity, Display Metrics, Magnetometer, OrientationSensor, Gyroscope, and Power. + +You may have registered an event hander for one of these: + +Gyroscope.ReadingChanged += OnReadingChanged; + +and then implemented the handler: + +void OnReadingChanged(GyroscopeChangedEventArgs e) +{ +} + +Instead of using a custom EventHander we now use EventHandler which always pass in an object as the first parameter: + +void OnReadingChanged(object sender, GyroscopeChangedEventArgs e) +{ +} + + +See our full release notes: http://aka.ms/essentials-releasenotes + + +## Feedback, Issues, & Feature Requests + +We would love to hear from you simply head to: http://aka.ms/essentialsfeedback