README.md in html-pipeline-negarmoji-0.0.4 vs README.md in html-pipeline-negarmoji-0.1.0
- old
+ new
@@ -1,91 +1,182 @@
-## Negareh
\ No newline at end of file
+<p align="center">
+ <br>
+ <a href="#">
+ <img src="logo.svg" width="100" alt="Negareh Emoji HTML Pipeline"/>
+ </a>
+</p>
+
+<h1 align="center">Negareh Emoji HTML Pipeline</h1>
+<h3 align="center">HTML emoji filter pipeline to convert emoji aliases to actual emoji images.</h3>
+
+<p align="center">
+ <a title="Open Source" href="https://opensource.com/resources/what-open-source" target="_blank">
+ <img src="https://img.shields.io/badge/Open%20Source-Forever-brightgreen?logo=open-source-initiative&style=flat-square" alt="Open Source">
+ </a>
+ <a title="License: GPLv3" href="https://www.opensource.org/licenses/GPL-3.0" target="_blank">
+ <img src="https://img.shields.io/github/license/azadeh-afzar/Negareh-Emoji-HTML-Pipeline?logo=gnu&style=flat-square" alt="License: GPLv3">
+ </a>
+ <a title="Language counter" href="#" target="_blank">
+ <img src="https://img.shields.io/github/languages/count/azadeh-afzar/Negareh-Emoji-HTML-Pipeline?logo=gitlab&style=flat-square" alt="Language counter">
+ </a>
+ <a title="Top language" href="#" target="_blank">
+ <img src="https://img.shields.io/github/languages/top/azadeh-afzar/Negareh-Emoji-HTML-Pipeline?logo=gitlab&style=flat-square" alt="Top language">
+ </a>
+
+ <br>
+
+ <a title="Code Quality: Codefactor.io" href="https://www.codefactor.io/repository/github/azadeh-afzar/Negareh-Emoji-HTML-Pipeline" target="_blank">
+ <img src="https://www.codefactor.io/repository/github/azadeh-afzar/Negareh-Emoji-HTML-Pipeline/badge?style=flat-square" alt="CodeFactor"/>
+ </a>
+ <a title="Code Quality: CodeClimate.com" href="https://codeclimate.com/github/azadeh-afzar/Negareh-Emoji-HTML-Pipeline/maintainability" target="_blank">
+ <img src="https://img.shields.io/codeclimate/maintainability/azadeh-afzar/Negareh-Emoji-HTML-Pipeline?logo=code-climate&style=flat-square" alt="CodeClimate rating"/>
+ </a>
+ <a title="Code Technical Debt: CodeClimate.com" href="https://codeclimate.com/github/azadeh-afzar/Negareh-Emoji-HTML-Pipeline/maintainability" target="_blank">
+ <img src="https://img.shields.io/codeclimate/tech-debt/azadeh-afzar/Negareh-Emoji-HTML-Pipeline?logo=code-climate&style=flat-square" alt="CodeClimate technical debt"/>
+ </a>
+ <a title="Code Issues: CodeClimate.com" href="https://codeclimate.com/github/azadeh-afzar/Negareh-Emoji-HTML-Pipeline/maintainability" target="_blank">
+ <img src="https://img.shields.io/codeclimate/issues/azadeh-afzar/Negareh-Emoji-HTML-Pipeline?logo=code-climate&style=flat-square" alt="CodeClimate issues"/>
+ </a>
+
+ <br>
+
+ <a title="GitLab: pipeline status" href="https://gitlab.com/Azadeh-Afzar/Web-Development/Negareh-Emoji-HTML-Pipeline/commits/master" target="_blank">
+ <img src="https://img.shields.io/gitlab/pipeline/Web-Development/Negareh-Emoji-HTML-Pipeline?gitlab_url=https%3A%2F%2Fgitlab.com%2FAzadeh-Afzar&logo=gitlab&style=flat-square" alt="pipeline status" />
+ </a>
+ <a title="Test Coverage: CodeClimate.com" href="https://codeclimate.com/github/azadeh-afzar/Negareh-Emoji-HTML-Pipeline" target="_blank">
+ <img src="https://img.shields.io/codeclimate/coverage/azadeh-afzar/Negareh-Emoji-HTML-Pipeline?logo=code-climate&style=flat-square" alt="CodeClimate"/>
+ </a>
+
+ <br>
+
+ <a title="Gem Version" href="https://rubygems.org/gems/html-pipeline-negarmoji">
+ <img src="https://img.shields.io/gem/v/html-pipeline-negarmoji?color=red&label=Negareh%20Emoji%20HTML%20Pipeline&logo=rubygems&style=flat-square" alt="Gem Version">
+ </a>
+</p>
+
+> If you are viewing this repository on GitHub, this GitHub repository is a mirror of the Negareh Emoji HTML Pipeline,
+> the main repository is served on
+><a href="https://gitlab.com/Azadeh-Afzar/Web-Development/Negareh-Emoji-HTML-Pipeline">GitLab</a>, all developments and
+>discussions, issue tracking and merge requests take place in GitLab.
+
+
+## Negareh Emoji Library
+
+
+Negareh emoji library is an emoji filter plugin for html pipeline, this package is
+more flexible and customizable then the default emoji filter in html/pipeline.
+
+
+### Installation
+
+Add `html-pipeline-negarmoji` to your Gemfile.
+
+``` ruby
+gem 'negarmoji'
+```
+
+## Contribution
+
+If you want to contribute to this project, please read [CONTRIBUTING](CONTRIBUTING.md).
+
+## Code of Conduct
+
+Visit the [Code of Conduct](CODE_OF_CONDUCT.md).
+
+## Roadmap
+
+Visit the [Roadmap](ROADMAP.md) to keep track of which features we are currently
+working on.
+
+## License
+
+Licensed under the [GPLv3](LICENSE).