Skip to content

Commit 0595ab3

Browse files
committed
added example
1 parent c3e2c68 commit 0595ab3

File tree

2 files changed

+58
-7
lines changed

2 files changed

+58
-7
lines changed

README.md

Lines changed: 57 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,59 @@
1-
<div><section><h1>React UIkit Article</h1><p>Create articles within your page.</p><p><a href="http://otissv.github.io/react-uikit-components/">http://otissv.github.io/react-uikit-components</a> for docs.</p></section><section><h2>Usage</h2><pre data-kitid="ciiumo6jt000041mdhdejr4cc"><code>npm install react-uikit-article --save;
1+
#React UIkit Article
22

3-
// ES6
4-
import Article from &#x27;react-uikit-article&#x27;;
3+
Create articles within your page.
54

6-
// ES5
7-
var Article = require(&#x27;react-uikit-article&#x27;);
8-
</code></pre></section><section><h2>Tests</h2><p><code>npm run test</code> to run tests with minimal output.<br/><code>npm run test:spec</code> to run tests with detailed output.<br/><code>npm run test:watch</code>watches all directories and run tests with minimal output on file changes.<br/></p></section><section><h2>Build</h2><p><code>npm run build</code> to build files fro distribution.<br/><code>npm run build:watch</code> watches src directory and builds files on changes.<br/></p></section><section><h2>Lint</h2><p><code>npm run lint</code> lints scripts in src directory.<br/><code>npm run lint:watch</code> watches src directory and lints scripts in src directory.<br/></p></section><section><h2>License</h2><p>MIT</p></section></div>
5+
See [http://otissv.github.io/react-uikit-components/](http://otissv.github.io/react-uikit-components) for docs.
6+
7+
8+
##Usage
9+
10+
###Installation
11+
12+
npm install react-uikit-article --save;
13+
14+
// ES6
15+
import Article from 'react-uikit-article';
16+
17+
// ES5
18+
var Article = require('react-uikit-article');
19+
20+
21+
### Example
22+
<Article
23+
title='Article title'
24+
meta='Written by Super User on 12 April 2012. Posted in Blog'
25+
lead='Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do
26+
eiusmod tempor incididunt ut labore et dolore magna aliqua.' >
27+
28+
<p>
29+
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod
30+
tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam,
31+
quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
32+
</p>
33+
34+
<hr className="uk-article-divider" />
35+
36+
<p>
37+
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod
38+
tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam,
39+
quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
40+
</p>
41+
<a href="#">Read more</a>
42+
</Article>
43+
44+
##Tests
45+
46+
`npm run test`to run tests with minimal output.
47+
`npm run test:spec` to run tests with detailed output.
48+
`npm run test:watch` watches all directories and run tests with minimal output on file changes.
49+
50+
##Build
51+
`npm run build` to build files fro distribution.
52+
`npm run build:watch` watches src directory and builds files on changes.
53+
54+
##Lint
55+
`npm run lint` lints scripts in src directory.
56+
`npm run lint:watch` watches src directory and lints scripts in src directory.
57+
58+
##License
59+
MIT

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "react-uikit-article",
3-
"version": "0.2.1",
3+
"version": "0.2.2",
44
"description": "React uikit article component to create articles within a page.",
55
"keywords": [
66
"javascript",

0 commit comments

Comments
 (0)