Skip to content

Commit 64e3237

Browse files
committed
docs(readme): Added guidelines and important links
1 parent cb6d168 commit 64e3237

1 file changed

Lines changed: 36 additions & 1 deletion

File tree

README.md

Lines changed: 36 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,40 @@
1010

1111
[Codepen Example](http://codepen.io/ritz078/full/WvvNGe/)
1212

13-
**The angular version of this plugin is [ngEmbed](http://github.com/ritz078/ngEmbed)**
13+
##Documentation
14+
15+
* [Features](http://riteshkr.com/embed.js/)
16+
* [Documentation](http://riteshkr.com/embed.js/getting_started.html)
17+
* [Examples](http://riteshkr.com/embed.js/examples.html)
18+
19+
##Creating custom build
20+
21+
Set the features you don't want to false in `build.json` and then run
22+
23+
```
24+
grunt build
25+
```
26+
27+
This will create a customized build of the plugin.
28+
29+
##Adding custom emojis
30+
31+
1. Add the image to `assets/images/emojis`. Make sure the name of the file is same as emoji name.
32+
2. Pass the emoji name as the value to `customEmoji`. See the example [here](http://riteshkr.com/embed.js/doc.html#emoji)
33+
3. Run `grunt build-emoji && grunt build`
34+
35+
##Contributing
36+
37+
1. Fork and clone the repo.
38+
1. Run `npm install` to install all build dependencies(including Grunt).
39+
1. Create a new branch, please DON'T work in your master branch directly.
40+
1. Run `grunt` so that you can see the impact of your changes on the browser while developing.
41+
1. Fix stuff or add new feature.
42+
1. This repo follows [Angular commit guidelines](https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#commit). For this we are using [commitizen](http://commitizen.github.io/cz-cli/). So instead of git commit, prefer using npm run commit and follow the guidelines.
43+
1. Update the documentation to reflect any changes.
44+
1. Push to your fork and submit a pull request.
45+
46+
##License
47+
48+
MIT ©
1449

0 commit comments

Comments
 (0)