Skip to content

Commit

Permalink
Update docs. [ci skip]
Browse files Browse the repository at this point in the history
  • Loading branch information
wehriam committed Oct 5, 2015
1 parent d07a0c9 commit d2b8204
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 16 deletions.
30 changes: 14 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,9 @@
- [Coordinate Multiple Components](#coordinate-multiple-components)
- [Debugging](#debugging)
- [API](#api)
- [`<Experiment />`](#experiment-)
- [`<Experiment />` Component](#experiment--component)
- [`<Variant />` Component](#variant--component)
- [`props.name`](#propsname)
- [`props.defaultValue`](#propsdefaultvalue)
- [`<Variant />`](#variant-)
- [`props.name`](#propsname-1)
- [`emitter`](#emitter)
- [`.emitWin(experimentName)`](#emitwinexperimentname)
- [`experimentName`](#experimentname)
Expand Down Expand Up @@ -252,25 +250,25 @@ var winSubscription = emitter.addWinListener("example", function(variantName){

## API

### `<Experiment />`
### `<Experiment />` Component

Experiment container component. Children must be of type [Variant](#variant-).

#### `props.name`
* #### `props.name`

* **Description:** The name of the experiment.
* **Required:** Yes
* **Type:** `string`
* **Example:** `"My Test"`
* **Description:** The name of the experiment.
* **Required:** Yes
* **Type:** `string`
* **Example:** `"My Test"`

#### `props.defaultValue`
* #### `props.defaultValue`

* **Description:** The name of the variant to default to.
* **Required:** No
* **Type:** `string`
* **Example:** `"A"`
* **Description:** The name of the variant to default to.
* **Required:** No
* **Type:** `string`
* **Example:** `"A"`

### `<Variant />`
### `<Variant />` Component

Variant component.

Expand Down
4 changes: 4 additions & 0 deletions circle.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
general:
branches:
only:
- master

0 comments on commit d2b8204

Please sign in to comment.