Skip to content

Commit 32c280c

Browse files
jeromelabanjeromelaban
committed
Update the documentation
1 parent 9d26386 commit 32c280c

File tree

1 file changed

+11
-63
lines changed

1 file changed

+11
-63
lines changed

‎README.md‎

Lines changed: 11 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,27 @@
1-
# Xamarin.Essentials
1+
# Uno.Xamarin.Essentials
22

3-
Xamarin.Essentials gives developers essential cross-platform APIs for their mobile applications.
4-
5-
iOS, Android, and UWP offer unique operating system and platform APIs that developers have access to, all in C# leveraging Xamarin. It is great that developers have 100% API access in C# with Xamarin, but these APIs are different per platform. This means developers have to learn three different APIs to access platform-specific features. With Xamarin.Essentials, developers have a single cross-platform API that works with any iOS, Android, or UWP application that can be accessed from shared code no matter how the user interface is created.
3+
**Uno.Xamarin.Essentials** is a fork of the [Xamarin.Essentials](https://github.com/xamarin/Essentials) library to enable WebAssembly support for Uno Platform based applications, as well as all the official Xamarin.Essential supported platforms.
64

7-
[![Gitter chat](https://badges.gitter.im/gitterHQ/gitter.png)](https://gitter.im/xamarin/Essentials)
5+
To use this library, you'll need to replace your references from `Xamarin.Essentials` to `Uno.Xamarin.Essentials`.
86

9-
## Build Status
7+
## Reporting issues
108

11-
| Build Server | Type | Platform | Status |
12-
|--------------|--------------|----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
13-
| VSTS | Build | Windows | ![VSTS Build Status](https://devdiv.visualstudio.com/_apis/public/build/definitions/0bdbc590-a062-4c3f-b0f6-9383f67865ee/8538/badge) |
14-
| Jenkins | Device Tests | macOS | [![Build Status](https://jenkins.mono-project.com/buildStatus/icon?job=Components-Essentials-DeviceTests-Mac)](https://jenkins.mono-project.com/job/Components-Essentials-DeviceTests-Mac) |
15-
| App Center | Sample App | Android | [![Build status](https://build.appcenter.ms/v0.1/apps/7a1f46ca-ba2f-477e-aacc-ff013c7d5f7a/branches/master/badge)](https://appcenter.ms) |
16-
| App Center | Sample App | iOS | [![Build status](https://build.appcenter.ms/v0.1/apps/43b39e9e-2b2b-482f-8afa-e9906334c85e/branches/master/badge)](https://appcenter.ms) |
9+
The implementation of the WebAssembly is provided through the UWP implementation of Xamarin.Essentials. This means that you may find parts that are not implemented, because the WinRT APIs may not yet be implemented in Uno.
1710

18-
## Sample App
19-
Try out Xamarin.Essentials on your device!
11+
If you find such an API, please [open an issue in the Uno Platform repository](https://github.com/unoplatform/uno/issues/new/choose) to let us know about it!
2012

21-
* [Android Sample App](https://install.appcenter.ms/orgs/microsoft-liveplayer/apps/essentials-android/distribution_groups/public%20testers) via App Center.
13+
## Xamarin.Essentials Documentation
2214

23-
## Installation
24-
25-
Xamarin.Essentials is available via:
15+
Xamarin.Essentials gives developers essential cross-platform APIs for their mobile applications.
2616

27-
* NuGet Official Releases: [![NuGet](https://img.shields.io/nuget/vpre/Xamarin.Essentials.svg?label=NuGet)](https://www.nuget.org/packages/Xamarin.Essentials)
17+
iOS, Android, and UWP offer unique operating system and platform APIs that developers have access to, all in C# leveraging Xamarin. It is great that developers have 100% API access in C# with Xamarin, but these APIs are different per platform. This means developers have to learn three different APIs to access platform-specific features. With Xamarin.Essentials, developers have a single cross-platform API that works with any iOS, Android, or UWP application that can be accessed from shared code no matter how the user interface is created.
2818

29-
Please read our [Getting Started with Xamarin.Essentials guide](https://docs.microsoft.com/xamarin/essentials/get-started) for full setup instructions.
19+
[![Gitter chat](https://badges.gitter.im/gitterHQ/gitter.png)](https://gitter.im/xamarin/Essentials)
3020

3121
## Documentation
3222

3323
Browse our [full documentation for Xamarin.Essentials](https://docs.microsoft.com/xamarin/essentials), including feature guides, on how to use each feature.
3424

35-
## Supported Platforms
36-
37-
Xamarin.Essentials is focused on the following platforms:
38-
39-
* iOS (10+)
40-
* Android (4.4+)
41-
* UWP (Fall Creators Update+)
42-
4325
## API Documentation
4426

4527
The following cross-platform APIs are available in Xamarin.Essentials:
@@ -76,38 +58,4 @@ The following cross-platform APIs are available in Xamarin.Essentials:
7658

7759
## Contributing
7860

79-
Please read through our [Contribution Guide](CONTRIBUTING.md). We are not accepting new PRs for full features, however any [issue that is marked as `up for grabs`](https://github.com/xamarin/Essentials/issues?q=is%3Aissue+is%3Aopen+label%3A%22up+for+grabs%22) are open for community contributions. We encourage creating new issues for bugs found during usage that the team will triage. Additionally, we are open for code refactoring suggestions in PRs.
80-
81-
## Building Xamarin.Essentials
82-
83-
Xamarin.Essentials is built with the new SDK-style projects with multi-targeting enabled. This means that all code for iOS, Android, and UWP exist inside of the Xamarin.Essentials project.
84-
85-
If building on Visual Studio 2017, you will need the following SDKs and workloads installed:
86-
87-
### Workloads need:
88-
89-
* Xamarin
90-
* .NET Core
91-
* UWP
92-
93-
### You will need the following SDKs
94-
95-
* Android 9.0, 8.1, 8.0, 7.1, 7.0, & 6.0 SDK Installed
96-
* UWP 10.0.16299 SDK Installed
97-
98-
If using Visual Studio for Mac the project can be built at the command line with MSBuild. To change the project type that you are working with, simply edit Xamarin.Essentials.csproj and modify the TargetFrameworks for only the project type you want to use.
99-
100-
To build through the command line, navigate to where Xamarin.Essentials.csproj exists then run:
101-
102-
```csharp
103-
msbuild /restore Xamarin.Essentials.csproj
104-
```
105-
106-
## FAQ
107-
108-
Here are some frequently asked questions about Xamarin.Essentials, but be sure to read our full [FAQ on our Wiki](https://github.com/xamarin/Essentials/wiki#feature-faq).
109-
110-
## License
111-
112-
Please see the [License](LICENSE).
113-
61+
Please read through our [Contribution Guide](CONTRIBUTING.md). We are not accepting new PRs for full features, however any [issue that is marked as `up for grabs`](https://github.com/xamarin/Essentials/issues?q=is%3Aissue+is%3Aopen+label%3A%22up+for+grabs%22) are open for community contributions. We encourage creating new issues for bugs found during usage that the team will triage. Additionally, we are open for code refactoring suggestions in PRs.

0 commit comments

Comments
 (0)