Skip to content

Commit

Permalink
modifying README
Browse files Browse the repository at this point in the history
  • Loading branch information
nashio committed Jul 6, 2017
1 parent 2c0c963 commit 7406144
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 2 deletions.
29 changes: 27 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# ract-tiny-tabs

![](http://nashio.github.io/react-tiny-tabs/examples/demo/assets/img/logo.png)

Easy to use React tab component
* Choose from 3 themes
* Define transition speed or use the navigation in the bottom
Expand All @@ -8,12 +10,17 @@ Easy to use React tab component
* Constrain content to match the nav width
* Customize colors for text and background

<br/>![](http://ignaciochavez.com/files/react-tiny-tabs/ract-tabs.png)
<br/>![](http://nashio.github.io/react-tiny-tabs/examples/demo/assets/img/demo.jpg)

### Demo
See the live [DEMO:](nashio.github.com/tiny-tabs)

### Usage
## Usage
<!-- ### Install -->
<!-- ``` -->
<!-- npm install -D react-tiny-tabs -->
<!-- ``` -->
#### Include the Components

```
import {Tabs, Nav, Content} from 'react-tiny-tabs';
Expand All @@ -39,6 +46,11 @@ See the live [DEMO:](nashio.github.com/tiny-tabs)
```

#### Include the CSS
```
<link rel="stylesheet" href="node_modules/react-tiny-tabs/dist/index.css">
```

### Options

| option | type | description |
Expand Down Expand Up @@ -70,6 +82,19 @@ Added custom html properties will be rendered in the resulting markup
</Nav>
```

### Files

Code example
#### [demo/index.html/](https://github.com/nashio/react-tiny-tabs/blob/master/examples/demo/index.html "code examples")

Source file
#### [src/](https://github.com/nashio/react-tiny-tabs/tree/master/src "source file")

Build files
#### [dist/](https://github.com/nashio/react-tiny-tabs/tree/master/dist "build files")



### License

MIT
Binary file added examples/demo/assets/img/demo.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 7406144

Please sign in to comment.