nativescript-oauth2 - npm Package Compare versions

Comparing version 1.1.3 to 1.1.4

package.json

 {
   "name": "nativescript-oauth2",
-  "version": "1.1.3",
+  "version": "1.1.4",
   "description": "OAuth 2 login for NativeScript.",
@@ -5,0 +5,0 @@ "main": "oauth",

README.md

@@ -118,3 +118,3 @@ # OAuth 2 Plugin for NativeScript
 
-If you are using NativeScript-Vue, then you'll have to add this registration code somewhere when your app bootstraps. A demo app is coming soon.
+If you are using NativeScript-Vue, then you'll have to add this registration code somewhere when your app bootstraps. A Vue demo app is included with the GitHub repo.
 
@@ -197,13 +197,25 @@ ```typescript
 
-If you don't see an auth provider that you need, you can just implement your own.
+If you don't see an auth provider that you need, you can just implement your own - see the `demo-custom-provider` project in the GitHub repo for an example on how to do this.
 
-If your provider supports OpenId, simply implement your provider's options by extending the `TnsOaUnsafeProviderOptions` interface if your provider is not Open Id compliant, or the `TnsOaOpenIdProviderOptions` interface if your provider IS Open Id compliant.
+You need to implement two interfaces: provider options that suits your provider (more below), and `TnsOaProvider` for the provider endpoint details.
 
+#### Provider Options
+
+Implement your provider's options by extending the `TnsOaUnsafeProviderOptions` interface **if your provider is not Open Id compliant**, or the `TnsOaOpenIdProviderOptions` interface **if your provider *is* Open Id compliant**.
+
+> Note: the interface is named with the word 'unsafe' in the name because non-open id compliant providers (like Facebook) usually make you use a client secret to send to the provider in exchange for the token. Storing the secret somewhere other than the client app is recommended (like a proxy), but most people don't do this and just store the secret with the app - thus unsafe.
+
 ```typescript
+//Provider options example
+
 export interface TnsOaMyCustomProviderOptions extends TnsOaUnsafeProviderOptions { }
 ```
 
+#### TnsOaProvider
+
 Then you can create your provider class by implementing the `TnsOaProvider` interface:
 
 ```typescript
+//Provider implementation example
+
 export class TnsOaProviderMyCustomProvider implements TnsOaProvider {
@@ -242,2 +254,3 @@ public options: TnsOaProviderOptions;
 // auth-service.ts
+
 export function configureOAuthProviders() {
@@ -244,0 +257,0 @@ const myCustomProvider = configureOAuthProviderMyCustomProvider();

No alert changes

Improved metrics

Total package byte prevSize

96462

increased by0.75%

Number of lines in readme file

337

increased by4.01%

No dependency changes