Skip to content

Commit 35d8642

Browse files
committed
Update README
1 parent 6ffc875 commit 35d8642

1 file changed

Lines changed: 11 additions & 38 deletions

File tree

README.md

Lines changed: 11 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# A/B Testing React Components
22

33
[![NPM Version](https://badge.fury.io/js/react-ab-test.svg)](https://www.npmjs.com/package/react-ab-test)
4-
[![Circle CI](https://circleci.com/gh/pushtell/react-ab-test.svg?style=shield)](https://circleci.com/gh/pushtell/react-ab-test)
5-
[![Coverage Status](https://coveralls.io/repos/pushtell/react-ab-test/badge.svg?branch=master&service=github)](https://coveralls.io/github/pushtell/react-ab-test?branch=master)
6-
[![Dependency Status](https://david-dm.org/pushtell/react-ab-test.svg)](https://david-dm.org/pushtell/react-ab-test)
7-
[![NPM Downloads](https://img.shields.io/npm/dm/react-ab-test.svg?style=flat)](https://www.npmjs.com/package/react-ab-test)
4+
[![Circle CI](https://circleci.com/gh/marvelapp/react-ab-test.svg?style=shield)](https://circleci.com/gh/marvelapp/react-ab-test)
5+
[![Coverage Status](https://coveralls.io/repos/marvelapp/react-ab-test/badge.svg?branch=master&service=github)](https://coveralls.io/github/marvelapp/react-ab-test?branch=master)
6+
[![Dependency Status](https://david-dm.org/marvelapp/react-ab-test.svg)](https://david-dm.org/marvelapp/react-ab-test)
7+
[![NPM Downloads](https://img.shields.io/npm/dm/react-ab-test.svg?style=flat)](https://www.npmjs.com/package/@marvelapp/react-ab-test)
88

99
Wrap components in [`<Variant />`](#variant-) and nest in [`<Experiment />`](#experiment-). A variant is chosen randomly and saved to local storage.
1010

@@ -27,7 +27,7 @@ emitter.addPlayListener(function(experimentName, variantName){
2727
});
2828
```
2929

30-
Please [★ on GitHub](https://github.com/pushtell/react-ab-test)!
30+
Please [★ on GitHub](https://github.com/marvelapp/react-ab-test)!
3131

3232
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
3333
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
@@ -78,10 +78,10 @@ Please [★ on GitHub](https://github.com/pushtell/react-ab-test)!
7878

7979
## Installation
8080

81-
`react-ab-test` is compatible with React 0.14.x and 0.15.x.
81+
`react-ab-test` is compatible with React >=0.14.x
8282

8383
```bash
84-
npm install react-ab-test
84+
yarn install react-ab-test
8585
```
8686

8787
## Usage
@@ -713,42 +713,15 @@ Before contribuiting you need:
713713

714714
Then you can:
715715
- Apply your changes :sunglasses:
716-
- Build your changes with `npm run build`
717-
- Test your changes with `npm test`
718-
- Lint your changes with `npm run lint`
716+
- Build your changes with `yarn build`
717+
- Test your changes with `yarn test`
718+
- Lint your changes with `yarn lint`
719719
- And finally open the PR! :tada:
720720

721-
### Browser Coverage
722-
[Karma](http://karma-runner.github.io/0.13/index.html) tests are performed on [Browserstack](https://www.browserstack.com/) in the following browsers:
723-
724-
* IE 9, Windows 7
725-
* IE 10, Windows 7
726-
* IE 11, Windows 7
727-
* Opera (latest version), Windows 7
728-
* Firefox (latest version), Windows 7
729-
* Chrome (latest version), Windows 7
730-
* Safari (latest version), OSX Yosemite
731-
* Android Browser (latest version), Google Nexus 7, Android 4.1
732-
* Mobile Safari (latest version), iPhone 6, iOS 8.3
733-
734-
[Mocha](https://mochajs.org/) tests are performed on the latest version of [Node](https://nodejs.org/en/).
735-
736-
Please [let us know](https://github.com/pushtell/react-ab-test/issues/new) if a different configuration should be included here.
737-
738721
### Running Tests
739722

740-
Locally:
741-
742-
```bash
743-
744-
npm test
745-
746-
```
747-
748-
On [Browserstack](https://www.browserstack.com/):
749-
750723
```bash
751724

752-
BROWSERSTACK_USERNAME=YOUR_USERNAME BROWSERSTACK_ACCESS_KEY=YOUR_ACCESS_KEY npm test
725+
yarn test
753726

754727
```

0 commit comments

Comments
 (0)