Skip to content

Commit d608db5

Browse files
doc(README): update documentation
- Add yarn as an install option - Remove line breaks - Remove lineBreak from WIP - Add Vimeo support as a WIP
1 parent c84ee99 commit d608db5

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

README.md

+10-9
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ A component for rendering Markdown in React Native with native components, worki
88
## Getting started
99

1010
`npm install react-native-simple-markdown --save`
11+
or
12+
`yarn add react-native-simple-markdown`
1113

1214
## Usage
1315

@@ -22,17 +24,17 @@ const MyAwesomeApp = () => {
2224
return (
2325
<Markdown styles={styles}>
2426
#Markdown in react-native is so cool!
25-
{'\n\n'}
27+
2628
You can **emphasize** what you want, or just _suggest it_ 😏…
27-
{'\n\n'}
29+
2830
You can even [link your website](http://charlesmangwa.surge.sh) or if you prefer: [email sombedy](mailto:email@somebody.com)
29-
{'\n\n'}
31+
3032
Spice it up with some GIF 💃:
31-
{'\n\n'}
33+
3234
![Some GIF](https://media.giphy.com/media/dkGhBWE3SyzXW/giphy.gif)
33-
{'\n\n'}
35+
3436
And even add a cool video 😎!
35-
{'\n\n'}
37+
3638
[![A cool video](https://img.youtube.com/vi/dQw4w9WgXcQ/0.jpg)](http://www.youtube.com/watch?v=dQw4w9WgXcQ)
3739
</Markdown>
3840
)
@@ -75,9 +77,8 @@ Example:
7577
#Hello 👋
7678
</Markdown>
7779
```
78-
*Note: The text inside the parentheses denotes the element type.*
7980
80-
##### Functional
81+
##### Features
8182
8283
- `br` (`<Text>`)
8384
- `del` (`<Text>`)
@@ -111,7 +112,7 @@ _Most of these elements can be used, but I'm still working on some improvements.
111112
- `autolink` (`<Text>`)
112113
- `blockQuote` (`<Text>`)
113114
- `codeBlock` (`<View>`)
114-
- `newline` (`<Text>`)
115+
- `video` (`<Image>`) - Only support YouTube video. Vimeo is comming soon!
115116
116117
## Credits
117118

0 commit comments

Comments
 (0)