From 68051ee8bc192787e87f700e0873beb1f8e43c40 Mon Sep 17 00:00:00 2001 From: Oleg Kasyanov Date: Wed, 11 Dec 2019 04:06:13 +0400 Subject: [PATCH] Updated README --- README.md | 34 +++++++++++++++++++++++++++++++++- 1 file changed, 33 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index dfb0add..856df55 100644 --- a/README.md +++ b/README.md @@ -9,14 +9,46 @@ but can be used freely in other projects. [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/mobicms/render/badges/quality-score.png?b=develop)](https://scrutinizer-ci.com/g/mobicms/render/?branch=develop) [![Packagist](https://img.shields.io/packagist/l/mobicms/render.svg)](https://packagist.org/packages/mobicms/render) -[![Packagist](https://img.shields.io/packagist/dt/mobicms/render)](https://packagist.org/packages/mobicms/render) +[![Source Code](http://img.shields.io/badge/source-mobicms/render-blue.svg)](https://github.com/mobicms/render) [![GitHub tag (latest SemVer)](https://img.shields.io/github/tag/mobicms/render.svg?label=stable)](https://github.com/mobicms/render/releases) +[![Packagist](https://img.shields.io/packagist/dt/mobicms/render)](https://packagist.org/packages/mobicms/render) This package started on the basis of [league/plates v.3.3.0](https://github.com/thephpleague/plates/releases/tag/3.3.0). The development of the original package went in a direction that was not suitable for our projects where Plates was used, so it was decided to develop our own separate library. The purpose of the development was to **simplify the source code as much as possible**, get rid of the unnecessary and **add the missing functionality**. +## Installation + +The preferred method of installation is via [Composer](http://getcomposer.org). Run the following +command to install the package and add it as a requirement to your project's +`composer.json`: + +```bash +composer require mobicms/render +``` + + +## Documentation + +Check out the [documentation wiki](https://github.com/mobicms/render/wiki) for detailed information +and code examples. + + +## Contributing + +Contributions are welcome! Please read [CONTRIBUTING](https://github.com/mobicms/render/blob/develop/.github/CONTRIBUTING.md) for details. + +This project adheres to a [Contributor Code of Conduct](https://github.com/mobicms/render/blob/develop/.github/CODE_OF_CONDUCT.md). +By participating in this project and its community, you are expected to uphold this code. + + +## License + +The mobicms/captcha library is licensed for use under the MIT License (MIT). +Please see [LICENSE](https://github.com/mobicms/render/blob/master/LICENSE) for more information. + + ## Our links - [**Project Website**](https://mobicms.org) and support forum - [**Facebook**](https://www.facebook.com/mobicms)