[go: nahoru, domu]

Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
zesik committed Feb 9, 2019
1 parent 02d85e2 commit fc2c1c8
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,12 @@ $ npm install --save react-splitter-layout

## Testing

To start example server, execute `example` script with `npm`.

```sh
$ npm run example
```

To run tests, execute `test` command with `npm`.

```sh
Expand All @@ -48,6 +54,7 @@ $ npm run coverage
```javascript
import React from 'react';
import SplitterLayout from 'react-splitter-layout';
import 'react-splitter-layout/lib/index.css';
class YourComponent extends React.Component {
render() {
Expand All @@ -63,6 +70,8 @@ $ npm run coverage
export default YourComponent;
```

*Note: From version 4.0.0, you need to import CSS files or handle it in your favorite way explicitly.*

## Usage

Write two parts of the layout as direct children of your `SplitterLayout` element.
Expand Down Expand Up @@ -137,6 +146,8 @@ The `SplitterLayout` component supports the following props.
## Release History
* 4.0.0
* Stylesheets are no longer integrated by default. It has to be handled in your favorite way.
* 3.0.0
* Add dragging and size change events.
* Drop support of React earlier than 15.5.0.
Expand Down

0 comments on commit fc2c1c8

Please sign in to comment.