Skip to content

Commit

Permalink
Merge pull request #4 from PanoramicRum/master
Browse files Browse the repository at this point in the history
Update README
  • Loading branch information
adrice727 authored Mar 10, 2017
2 parents 023f848 + 0a05372 commit fbe0410
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 8 deletions.
9 changes: 9 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# OpenTok Accelerator Sample App for JavaScript React CHANGELOG
All notable changes to this project will be documented in this file.

--------------------------------------

####[1.0.0]

Official release

12 changes: 4 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,15 @@
# OpenTok Accelerator Sample App for JavaScript React
[![GitHub release](https://img.shields.io/github/release/opentok/accelerator-sample-apps-js.svg)](./README.md)
[![license](https://img.shields.io/github/license/opentok/accelerator-sample-apps-js.svg)](./LICENSE)

## Quick start


###Configuration

This section shows you how to prepare and run the sample application. The app is built using [Accelerator Core JS](https://github.com/opentok/accelerator-core-js) and the following accelerator packs:
This document shows you how to prepare and run the sample application. The app is built using [Accelerator Core JS](https://github.com/opentok/accelerator-core-js) and the following accelerator packs:

- [Text Chat](https://www.npmjs.com/package/opentok-text-chat)
- [Screen Sharing](https://www.npmjs.com/package/opentok-screen-sharing)
- [Annotation](https://www.npmjs.com/package/opentok-annotation)

###Configuration

Add a `config.json` file with your OpenTok credentials to the `src` directory:
```javascript
{
Expand All @@ -23,14 +20,13 @@ Add a `config.json` file with your OpenTok credentials to the `src` directory:
```

### Deploying and running the app

This sample application was built with [Create React App](https://github.com/facebookincubator/create-react-app) and uses [webpack](https://webpack.github.io/) to transpile code.
```javascript
$ npm install
$ npm run start
```


----------


*Looking for a sample in plain JavaScript? Click [here](https://github.com/opentok/accelerator-core-js/tree/master/vanilla-js-sample-app).*

0 comments on commit fbe0410

Please sign in to comment.