Skip to content
This repository has been archived by the owner on May 15, 2024. It is now read-only.

Add in readme for install with helpful information. Bump MSBuild.Sdk.… #392

Merged
merged 1 commit into from
Jul 19, 2018
Merged

Add in readme for install with helpful information. Bump MSBuild.Sdk.… #392

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions Xamarin.Essentials.sln
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 2 additions & 1 deletion Xamarin.Essentials/Xamarin.Essentials.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,9 @@
<DebugType>pdbonly</DebugType>
</PropertyGroup>
<ItemGroup>
<None Include="..\nugetreadme.txt" PackagePath="readme.txt" Pack="true" />
<PackageReference Include="mdoc" Version="5.7.1" PrivateAssets="All" />
<PackageReference Include="MSBuild.Sdk.Extras" Version="1.6.37-preview" PrivateAssets="All" />
<PackageReference Include="MSBuild.Sdk.Extras" Version="1.6.41" PrivateAssets="All" />
<PackageReference Include="System.Numerics.Vectors" Version="4.5.0" />
<Compile Include="**\*.shared.cs" />
<Compile Include="**\*.shared.*.cs" />
Expand Down
44 changes: 44 additions & 0 deletions nugetreadme.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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<T> 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