Skip to content

Commit 9872d0b

Browse files
authored
Merge pull request #62 from simeg/clean-up-readme
Clean up README
2 parents a0809c6 + a9e0610 commit 9872d0b

File tree

1 file changed

+16
-13
lines changed

1 file changed

+16
-13
lines changed

README.md

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -23,16 +23,18 @@ React Tooltip
2323
[download-image]: https://img.shields.io/npm/dm/rc-tooltip.svg?style=flat-square
2424
[download-url]: https://npmjs.org/package/rc-tooltip
2525

26-
## Screenshots
26+
## Screenshot
2727

2828
<img src="http://gtms03.alicdn.com/tps/i3/TB1NQUSHpXXXXaUXFXXlQqyZXXX-1312-572.png" width="600"/>
2929

30-
## Feature
30+
## Browser Support
3131

32-
* support ie8,ie8+,chrome,firefox,safari
32+
|![IE](https://raw.github.com/alrra/browser-logos/master/internet-explorer/internet-explorer_48x48.png) | ![Chrome](https://raw.github.com/alrra/browser-logos/master/chrome/chrome_48x48.png) | ![Firefox](https://raw.github.com/alrra/browser-logos/master/firefox/firefox_48x48.png) | ![Opera](https://raw.github.com/alrra/browser-logos/master/opera/opera_48x48.png) | ![Safari](https://raw.github.com/alrra/browser-logos/master/safari/safari_48x48.png)|
33+
| --- | --- | --- | --- | --- |
34+
| IE 8 + IE 8+ ✔ | Chrome 31.0+ ✔ | Firefox 31.0+ ✔ | Opera 30.0+ ✔ | Safari 7.0+ ✔ |
3335

3436

35-
## install
37+
## Install
3638

3739
[![rc-tooltip](https://nodei.co/npm/rc-tooltip.png)](https://npmjs.org/package/rc-tooltip)
3840

@@ -41,19 +43,20 @@ React Tooltip
4143
```js
4244
var Tooltip = require('rc-tooltip');
4345
var React = require('react');
44-
var ReactDOM = require('react-dom')
46+
var ReactDOM = require('react-dom');
4547
ReactDOM.render(<Tooltip placement="left" trigger={['click']} overlay={<span>tooltip</span>}><a href='#'>hover</a></Tooltip>, container);
4648
```
4749

48-
## Example
50+
## Examples
4951

50-
http://localhost:8007/examples
52+
`npm start` and then go to
53+
[http://localhost:8007/examples](http://localhost:8007/examples)
5154

52-
online example: http://react-component.github.io/tooltip/examples/
55+
Online examples: [http://react-component.github.io/tooltip/examples/](http://react-component.github.io/tooltip/examples/)
5356

5457
## API
5558

56-
### props
59+
### Props
5760

5861
<table class="table table-bordered table-striped">
5962
<thead>
@@ -173,19 +176,19 @@ online example: http://react-component.github.io/tooltip/examples/
173176

174177
## Development
175178

176-
```
179+
```bash
177180
npm install
178181
npm start
179182
```
180183

181184
## Test Case
182185

183-
http://localhost:8007/tests/runner.html?coverage
186+
[http://localhost:8007/tests/runner.html?coverage](http://localhost:8007/tests/runner.html?coverage)
184187

185188
## Coverage
186189

187-
http://localhost:8007/node_modules/rc-server/node_modules/node-jscover/lib/front-end/jscoverage.html?w=http://localhost:8007/tests/runner.html?coverage
190+
[http://localhost:8007/node_modules/rc-server/node_modules/node-jscover/lib/front-end/jscoverage.html?w=http://localhost:8007/tests/runner.html?coverage](http://localhost:8007/node_modules/rc-server/node_modules/node-jscover/lib/front-end/jscoverage.html?w=http://localhost:8007/tests/runner.html?coverage)
188191

189192
## License
190193

191-
rc-tooltip is released under the MIT license.
194+
`rc-tooltip` is released under the MIT license.

0 commit comments

Comments
 (0)