update doc

rsuite-legacy · Jul 18, 2017 · b64e66a · b64e66a
1 parent dd05cce
commit b64e66a
Show file tree

Hide file tree

Showing 4 changed files with 29 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -10,22 +10,22 @@
 |children|`String`|--|CopyToClipboard is a simple wrapping component, it does not render any tags, so it requires the only child element to be present, which will be used to capture clicks.|
 |onCopy|`function(text,result)`|--|Optional callback, will be called when text is copied|
 
-## AutoComplete.copy
+## Clipboard.copy
 If you don't want to use `Clipboard`, you can execute this function to copy text in clipboard.
 ```
  @param {String} text - Text to be copied to clipboard. 
  @return {Boolean} - Whether copy success.
 ```
 
-##  AutoComplete.select
+##  Clipboard.select
 Programmatically select the text of a HTML element.
 ```
  @param {HTMLElement} Element
 ```
 
 ## Example
 
-### install
+### Install
 ```bash
 npm install rsuite-clipboard --save
 ```

diff --git a/example/container/App.js b/example/container/App.js
@@ -15,7 +15,10 @@ class App extends Component {
                         </Navbar.Header>
                         <Navbar.Collapse>
                             <Nav pullRight>
-                                <Nav.Item href="https://github.com/rsuite/rsuite-clipboard">GitHub</Nav.Item>
+                                <Nav.Item href="https://github.com/rsuite/rsuite-clipboard">
+                                    <IconFont icon="github"/>
+                                    {' GitHub'}
+                                </Nav.Item>
                             </Nav>
                         </Navbar.Collapse>
                     </div>
@@ -24,6 +27,17 @@ class App extends Component {
                 <div className="container">
                     <h1>{'<Clipboard/>'}</h1>
                     <hr/>
+                    <p>
+                        <a href="https://www.bithound.io/github/rsuite/rsuite-clipboard">
+                            <img src="https://www.bithound.io/github/rsuite/rsuite-clipboard/badges/score.svg"
+                                 alt="bitHound Overall Score"
+                            />
+                        </a>
+                        {' '}
+                        <a href="https://badge.fury.io/js/rsuite-clipboard">
+                            <img src="https://badge.fury.io/js/rsuite-clipboard.svg" alt="npm version"/>
+                        </a>
+                    </p>
                     <p>Modern copy to clipboard for react.</p>
                     {this.props.children}
                 </div>

diff --git a/example/container/Home.js b/example/container/Home.js
@@ -8,6 +8,11 @@ class Home extends Component {
         return (
             <div>
                 <h2>Example</h2>
+                <div className="row">
+                    <div className="col-md-8">
+                        <Markdown>{require('../md/basic_pre.md')}</Markdown>
+                    </div>
+                </div>
                 <div className="row">
                     <div className="col-md-8">
                         <Markdown>{require('../md/basic.md')}</Markdown>

diff --git a/example/md/basic_pre.md b/example/md/basic_pre.md
@@ -0,0 +1,6 @@
+#### Install
+```bash
+npm install rsuite-clipboard --save
+```
+
+#### Usage