Skip to content

Commit

Permalink
readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Jed Wheeler authored and Jed Wheeler committed Oct 29, 2015
1 parent 3100954 commit b8eb9c8
Showing 1 changed file with 19 additions and 4 deletions.
23 changes: 19 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,25 @@
# Branch Cordova SDK

## Full Documentation
Find exhaustive documentation at our [New documentation portal](https://dev.branch.io). You may also find our [support portal](http://support.branch.io), complete with with user forums, useful.
This is the readme file of our open source Cordova SDK. The Cordova SDK shares the same code base as the Branch Web SDK, and includes functions to call all of the same API endpoints. You can find a live demo of the Web SDK: [https://cdn.branch.io/example.html](https://cdn.branch.io/example.html)

The Cordova SDK shares the same code base as the Branch Web SDK, and includes functions to call all of the same API endpoints.
=======

Live demo of the Web SDK: [https://cdn.branch.io/example.html](https://cdn.branch.io/example.html)
## Integration Checklist

To use the Cordova SDK, you'll need to first initialize it with your Branch Key found in your [Branch dashboard](https://dashboard.branch.io/#/settings). You'll also need to register when your users login with `setIdentity`, and when they logout with `logout`.
- Create Branch Account and get your [Branch Key]((https://dashboard.branch.io/#/settings)
- Install SDK
- Configure Manifest
- Set up routing for incoming deep links
- Initialize Branch
- Log user sessions
- Set up sharing
- Track events (optional)
- Set up referrals (optional)

## Additional Resources
- [Integration guide](https://dev.branch.io/recipes/quickstart_guide/cordova/)
- Technical Reference (in this repo)
- Changelog (in this repo)
- [Testing](https://dev.branch.io/recipes/testing_your_integration/cordova/)
- [Support portal, FAQ, and user forums](http://support.branch.io)

0 comments on commit b8eb9c8

Please sign in to comment.