-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' into chore/docs
- Loading branch information
Showing
2 changed files
with
13 additions
and
33 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
## Deployment | ||
|
||
This SDK is only available via NPM. To deploy a new version: | ||
|
||
``` | ||
npm publish | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,30 +1,16 @@ | ||
# Cobrowse.io - React Native SDK | ||
|
||
Cobrowse.io is 100% free and easy to try out in your own apps. Please see full documentation at [https://docs.cobrowse.io](https://docs.cobrowse.io). | ||
Cobrowse.io is 100% free and easy to try out in your own apps. | ||
|
||
Try our **online demo** at the bottom of our homepage at <https://cobrowse.io/#tryit>. | ||
Register an account at [https://cobrowse.io/register](https://cobrowse.io/register). | ||
|
||
## Installation | ||
|
||
```bash | ||
npm install --save cobrowse-sdk-react-native | ||
(cd ios && pod install) | ||
``` | ||
**Note:** For older versions of React Native, you may need to run `react-native link` before running `pod install`. | ||
|
||
### Add your License Key | ||
Please see **full documentation** at [https://docs.cobrowse.io](https://docs.cobrowse.io). | ||
|
||
Please register an account and generate your free License Key at <https://cobrowse.io/dashboard/settings>. | ||
Try our **online demo** at <https://cobrowse.io/demo>. | ||
|
||
This will associate sessions from your mobile app with your Cobrowse account. | ||
|
||
```javascript | ||
import CobrowseIO from 'cobrowse-sdk-react-native'; | ||
|
||
CobrowseIO.license = "put your license key here"; | ||
CobrowseIO.start(); | ||
## Installation | ||
|
||
``` | ||
See the [installation documentation](https://docs.cobrowse.io/sdk-installation/react-native) to get started. | ||
|
||
## Try it out | ||
|
||
|
@@ -48,16 +34,3 @@ Once you have your app running in the iOS Simulator or on a physical device, nav | |
|
||
## Questions? | ||
Any questions at all? Please email us directly at [[email protected]](mailto:[email protected]). | ||
|
||
## Requirements | ||
|
||
* iOS 9.0 or later | ||
* Android API version 19 (4.4 KitKat) or later | ||
|
||
## Deployment | ||
|
||
This SDK is only available via NPM. To deploy a new version: | ||
|
||
``` | ||
npm publish | ||
``` |