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

Commit 85d6efc

Browse files
committed
docs added to the root GettingStarted.md, Details.md and License.md
removed old xml docs
1 parent 2cf62dc commit 85d6efc

File tree

103 files changed

+2228
-12516
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

103 files changed

+2228
-12516
lines changed

Details.md

+58-8
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,26 @@
1-
Xamarin.Auth helps you authenticate users via standard authentication mechanisms (e.g. OAuth 1.0 and 2.0), and store user credentials. It's also straightforward to add support for non-standard authentication schemes. The library is cross-platform, so once you learn it on iOS, you're all set on Android.
1+
# Xamarin.Auth
22

3-
```csharp
4-
using Xamarin.Auth;
3+
Xamarin.Auth makes authenticating with OAuth easy! Xamarin.Auth helps developers authenticate
4+
users via standard authentication mechanisms (e.g. OAuth 1.0 and 2.0), and store user
5+
credentials. It's also straightforward to add support for non-standard authentication schemes.
56

7+
OAuth flow (process) is setup in 5 major steps:
8+
9+
1. Server side setup for OAuth service provider (Google, Facebook)
10+
2. Client side initialization of Authenticator object
11+
3. Creating and optionally customizing UI
12+
4. Presenting/Lunching UI and authenticating user
13+
5. Using identity
14+
15+
16+
``` csharp
617
var auth = new OAuth2Authenticator (
718
clientId: "App ID from https://developers.facebook.com/apps",
819
scope: "",
920
authorizeUrl: new Uri ("https://m.facebook.com/dialog/oauth/"),
10-
redirectUrl: new Uri ("http://www.facebook.com/connect/login_success.html"));
11-
21+
redirectUrl: new Uri ("http://www.facebook.com/connect/login_success.html"),
22+
isUsingNativeUI: false);
23+
1224
auth.Completed += (sender, eventArgs) => {
1325
DismissViewController (true, null);
1426
if (eventArgs.IsAuthenticated) {
@@ -17,8 +29,46 @@ auth.Completed += (sender, eventArgs) => {
1729
}
1830

1931
PresentViewController (auth.GetUI (), true, null);
20-
```
32+
```
33+
34+
35+
Xamarin.Auth is cross-platform, so once user learns how to use it on one platform,
36+
it is fairly simple to use it on other platforms. Xamarin.Auth has grown into fully
37+
fledged cross platform library supporting:
38+
39+
* Xamarin.Android
40+
* Xamarin.iOS
41+
* Windows Phone Silverlight 8
42+
* Windows Store 8.1 WinRT
43+
* Windows Phone 8.1 WinRT
44+
* Universal Windows Platform (UWP)
45+
46+
47+
## Current version and status
48+
49+
[![Xamarin.Auth][3]][4]
50+
[![Components-XamarinAuth][1]][2]
51+
52+
53+
**nuget version 1.5.0**
54+
55+
* Native UI (CustomTabs on Android and SFSafariViewController on iOS)
56+
* Xamarin.Forms support
57+
* Xamarin.Android (tested)
58+
* Xamarin.iOS (tested)
59+
* Windows platforms (tests in progress)
60+
61+
* Xamarin.iOS Embedded Browser WKWebView support as alternative
62+
WKWebView instead of UIWebView
63+
64+
## Support
2165

22-
It's that easy to authenticate users!
66+
Xamarin.Auth is open source and a part of the [.Net Foundation][5]. To open a pull
67+
request or file an issue please see visit the [Xamairn.Auth][6] GitHub repository.
2368

24-
*Some screenshots assembled with [PlaceIt](http://placeit.breezi.com/).*
69+
[1]: https://jenkins.mono-project.com/view/Components/job/Components-XamarinAuth/badge/icon
70+
[2]: https://jenkins.mono-project.com/view/Components/job/Components-XamarinAuth
71+
[3]: https://img.shields.io/nuget/vpre/Xamarin.Auth.svg?maxAge=2592000&label=Xamarin.Auth%20nuget
72+
[4]: https://www.nuget.org/packages/Xamarin.Auth
73+
[5]: https://dotnetfoundation.org/projects
74+
[6]: https://github.com/xamarin/Xamarin.Auth

0 commit comments

Comments
 (0)