		@@ -1,5 +0,19 @@
		# Okra JS
		# Okra Widget JavaScript SDK
		![alt text](https://files.readme.io/41dcda7-react-native-black.svg)

		JS library for implementing Okra widget
		JS library for implementing the OkraJS widget - OkraJS is a safe and secure web drop-in module and this library provides a front-end web (also available in [iOS](https://github.com/okraHQ/okra-ios-sdk) and [Android](https://github.com/okraHQ/okra-android-sdk)) SDK for [account authentication](https://docs.okra.ng/docs/widget-properties) and [payment initiation](https://docs.okra.ng/docs/creating-a-charge) for each bank that Okra [supports](https://docs.okra.ng/docs/bank-coverage).

		## Try the demo
		Checkout the [widget flow](https://okra.ng/) to view how the Okra Widget works. Click "See How it Works"

		## Before getting started
		- Checkout our [get started guide](https://docs.okra.ng/docs/get-started-with-okra) to create your developer account and retrieve your Client Token, API Keys, and Private Keys.
		- Create a [sandbox customer](https://docs.okra.ng/docs/creating-sandbox-customers), so you can get connecting immediately.

		## buildWithShortURL
		- If you are using the `buildWithShortURL` version, you will first need to [create a link](https://docs.okra.ng/docs/widget-customization) on your dashboard, and use the `short url` returend at the end of the creation flow.

		Bonus Points
		- Setup [Slack Notifications](https://docs.okra.ng/docs/slack-integration) so you can see your API call statuses and re-run calls in real-time!

		## Installing
		@@ -36,3 +50,3 @@
		env: 'production-sandbox',
		app_id: ''// app_id from your app builder
		app_id: ''// app_id from your App builder
		key: '', // Your key from the Okra dashboard
		@@ -52,3 +66,3 @@ token: '', // Your token from the okra dashboard
		Okra.buildWithShortUrl({
		short_url: '', //Your short url from the link builder
		short_url: '', //Your short url from the App builder (https://dash.okra.ng/links)
		onSuccess: function(data){
		@@ -73,2 +87,5 @@ console.log('options success', data)
		\| `products` \| `Array` \| true \| `['Auth']` \| The Okra products you want to use with the widget.
		\| `payment` \| `Booelan` \| false \| \| Whether you want to initiate a payment (https://docs.okra.ng/docs/payments)
		\| `charge ` \| `Object` \| false \| \| Payment charge opject (https://docs.okra.ng/docs/creating-a-charge)
		\| `products` \| `Array` \| true \| `['Auth']` \| The Okra products you want to use with the widget.
		\| `logo ` \| `String(URL)` \| false \| Okra's Logo \|
		@@ -92,2 +109,3 @@ \| `name ` \| `String` \| false \| Your Company's name \| Name on the widget

		View a complete list of customizable options [here](https://docs.okra.ng/docs/widget-properties)

		@@ -98,3 +116,3 @@ ## Okra.buildWithShortUrl Options
		\|-----------------------\|----------------\|---------------------\|---------------------\|
		\| `short_url` \| `String` \| true \| Your generated url from link builder.
		\| `short_url` \| `String` \| true \| Your generated url from our [App builder](https://docs.okra.ng/docs/widget-customization).
		\| `onSuccess` \| `Function` \| false \| Action to perform after widget is successful
		@@ -105,5 +123,7 @@ \| `onClose` \| `Function` \| false \| Action to perform if widget is closed

		## Done connecting?
		Checkout our [API Overiview](https://docs.okra.ng/docs/api-overview) and see how to use the data you've received and [other products](https://docs.okra.ng/docs/selfie-verification) you can use to create more personalized experiences for your customers!

		## Need more options?
		Try our App Builder! [Click here to get started](https://dash.okra.ng/link-builder)
		## Not a developer?
		Get started without writing a single line of code, Try our App Builder! [Click here to get started] (https://dash.okra.ng/link-builder)

		@@ -110,0 +130,0 @@ ## Other information

okra-js - npm Package Compare versions

New alerts

Fixed alerts

Improved metrics