Skip to content

Commit 224dc25

Browse files
ritz078ritz078
committed
docs(readme): updated readme with contents
1 parent e8be03a commit 224dc25

1 file changed

Lines changed: 34 additions & 9 deletions

File tree

‎README.md‎

Lines changed: 34 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,38 @@
88

99
![screen](demo/demo.gif)
1010

11-
[Codepen Example](http://codepen.io/ritz078/full/WvvNGe/)
1211

1312

13+
## Contents
14+
15+
* [Features](#features)
16+
* [Installation](#Installation)
17+
* [Getting Started](#getting-started)
18+
* [Advanced Options](http://riteshkr.com/embed.js/doc.html)
19+
* [API](http://riteshkr.com/embed.js/api.html)
20+
* [Examples](http://riteshkr.com/embed.js/examples.html)
21+
* Development
22+
* [Creating custom build of the plugin](#creating-custom-build)
23+
* [Adding custom emojis](#adding-custom-emojis)
24+
* [Contributing](#contributing)
25+
26+
27+
28+
## Features
29+
30+
* enables embedding of emojis and font icons. Supports custom emojis and font icons.
31+
* Tweets embedding (require [widgets.js](http://platform.twitter.com/widgets.js))
32+
* Github Gists embedding
33+
* Supports code highlighting using the power of [highlight.js](https://highlightjs.org/).
34+
* supports video services like YOUTUBE, VIMEO, VINE, USTREAM, DAILYMOTION and LIVELEAK.
35+
* supports audio services like SPOTIFY and SOUNDCLOUD.
36+
* supports online code editors like CODEPEN, JSFIDDLE, JSBIN, IDEONE and PLUNKER.
37+
* supports photo Sharing services like FLICKR and INSTAGRAM.
38+
* supports Google Map embedding.
39+
* supports Markdown parsing (using [marked](https://github.com/chjj/marked))
40+
* converts links into HTML anchor tags.
41+
* Embeds media files
42+
* Supports [video.js](http://videojs.com/) for media embedding.
1443

1544
## Installation
1645

@@ -80,25 +109,21 @@ If you wan't to destroy the instance. It will also replace the processed string
80109
x.destroy()
81110
```
82111

83-
#### Documentation
84112

85-
* [Features](http://riteshkr.com/embed.js/)
86-
* [Full Documentation](http://riteshkr.com/embed.js/getting_started.html)
87-
* [Examples](http://riteshkr.com/embed.js/examples.html)
88113

89114
## Creating custom build
90115

91-
Set the features you don't want to false in `build.json` and then run
116+
Set the features you don't want to **false** in `build.json` and then run
92117

93-
```
118+
```
94119
grunt build
95120
```
96121

97122
This will create a customized build of the plugin.
98123

99124
## Adding custom emojis
100125

101-
1. Add the image to `assets/images/emojis`. Make sure the name of the file is same as emoji name.
126+
1. Add the image to **assets/images/emojis**. Make sure the name of the file is same as emoji name.
102127
2. Pass the emoji name as the value to `customEmoji`. See the example [here](http://riteshkr.com/embed.js/doc.html#emoji)
103128
3. Run `grunt build-emoji && grunt build`
104129

@@ -115,4 +140,4 @@ This will create a customized build of the plugin.
115140

116141
## License
117142

118-
MIT © [Ritesh Kumar](https://github.com/ritz078)
143+
MIT © [Ritesh Kumar](https://github.com/ritz078)

0 commit comments

Comments
 (0)