Add fixed tootip example

cedricdelpoux · Jul 3, 2015 · 0dd6b8c · 0dd6b8c
1 parent 8d36036
commit 0dd6b8c
Show file tree

Hide file tree

Showing 3 changed files with 35 additions and 9 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,8 +1,12 @@
 # Changelog
 
+## 1.0.3 - 2015-07-03
+
+* Added: fixed tooltip example  
+
 ## 1.0.2 - 2015-07-02
 
-* Changed: tooltips exemple screenshot
+* Changed: tooltips example screenshot
 
 ## 1.0.1 - 2015-07-02
 

diff --git a/README.md b/README.md
@@ -16,9 +16,31 @@ See [changelog](./CHANGELOG.md)
 
 ## Usage
 
-### Exemple
+### Examples
 
-![Tooltip exemple](/screenshots/themed-tooltips.png)
+![Tooltip example](/screenshots/themed-tooltips.png)
+
+#### Fixed Tooltip
+
+```js
+import React from 'react'
+import { Tooltip } from 'react-simple-tooltip'
+
+export default class MyComponent {
+  render() {
+    return (
+      <div>
+        <Tooltip>
+          <div>react-simple-tooltip</div>
+          <div>By cedricdelpoux</div> 
+        </Tooltip>
+      </div>
+    )
+  }
+}
+```
+
+#### Hover Tooltip
 
 ```js
 import React, { Component } from 'react'
@@ -45,8 +67,8 @@ export default class MyComponent extends Component {
         { this.state.tooltipTrigger
           ? (
             <Tooltip placement="top" trigger={ this.state.tooltipTrigger }>
-              <div>Line 1</div>
-              <div>Line 2</div> 
+              <div>react-simple-tooltip</div>
+              <div>By cedricdelpoux</div> 
             </Tooltip>
           )
           : null
@@ -64,9 +86,9 @@ export default class MyComponent extends Component {
 
 ### Props
 
-  * `placement`: String - one of ['top', 'right', 'bottom', 'left']
-  * `theme`: String - one of ['black', 'grey', 'blue', 'green', 'yellow', 'red']
-  * `trigger`: React element
+  * `placement`: String - by default is right - one of ['top', 'right', 'bottom', 'left']
+  * `theme`: String - by default is black - one of ['black', 'grey', 'blue', 'green', 'yellow', 'red']
+  * `trigger`: React element - by default is null
 
 ## Development
 

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "react-simple-tooltip",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "A lightweight and simple tooltip component for React",
   "repository": {
     "type": "git",