From 080c7e72478eeaa529dd032f45b122a76741eedb Mon Sep 17 00:00:00 2001 From: Anthony Axenov Date: Mon, 20 Dec 2021 10:41:46 +0800 Subject: [PATCH] =?UTF-8?q?=D0=98=D1=81=D0=BF=D1=80=D0=B0=D0=B2=D0=BB?= =?UTF-8?q?=D0=B5=D0=BD=20README?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 41 ++++++++++++++--------------------------- 1 file changed, 14 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index b29805b..5a734b2 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,13 @@ # АТОЛ Онлайн -[![Latest Stable Version](http://poser.pugx.org/axenov/atol-online/v)](https://packagist.org/packages/axenov/atol-online) -[![Latest Unstable Version](http://poser.pugx.org/axenov/atol-online/v/unstable)](https://packagist.org/packages/axenov/atol-online) -[![Packagist PHP Version Support](https://img.shields.io/packagist/php-v/axenov/atol-online)](https://packagist.org/packages/axenov/atol-online) -[![Total Downloads](https://img.shields.io/packagist/dt/axenov/atol-online)](https://packagist.org/packages/axenov/atol-online) -[![License](https://img.shields.io/packagist/l/axenov/atol-online?color=%23369883)](LICENSE) - Библиотека для фискализации чеков по 54-ФЗ через [облачные ККТ АТОЛ](https://online.atol.ru/). +[![GitHub Workflow Status (master)](https://img.shields.io/github/workflow/status/anthonyaxenov/atol-online/CI/master?logo=github)](https://github.com/anthonyaxenov/atol-online/actions/workflows/ci.yml) +[![codecov](https://codecov.io/gh/anthonyaxenov/atol-online/branch/master/graph/badge.svg?token=WR2IV7FTF0)](https://codecov.io/gh/anthonyaxenov/atol-online) +[![Stable Version](https://img.shields.io/packagist/v/axenov/atol-online?label=stable)](https://packagist.org/packages/axenov/atol-online) +[![Packagist PHP Version Support](https://img.shields.io/packagist/php-v/axenov/atol-online?color=%23787cb4)](https://packagist.org/packages/axenov/atol-online) +[![License](https://img.shields.io/packagist/l/axenov/atol-online?color=%23369883)](LICENSE) + **[Документация](/docs/readme.md)** Текущие поддерживаемые версии АТОЛ Онлайн: @@ -17,19 +17,13 @@ | v4 | 5.8 | 1.05 | Поддерживается | | v5 | 2.0 | 1.2 | В планах | -Состояние веток: - -| master | [![GitHub Workflow Status (master)](https://img.shields.io/github/workflow/status/anthonyaxenov/atol-online/CI/master?logo=github)](https://github.com/anthonyaxenov/atol-online/actions/workflows/ci.yml) | [![codecov](https://codecov.io/gh/anthonyaxenov/atol-online/branch/master/graph/badge.svg?token=WR2IV7FTF0)](https://codecov.io/gh/anthonyaxenov/atol-online) | -|--------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------| -| dev | [![GitHub Workflow Status (dev)](https://img.shields.io/github/workflow/status/anthonyaxenov/atol-online/CI/dev?logo=github)](https://github.com/anthonyaxenov/atol-online/actions/workflows/ci.yml) | [![codecov dev](https://codecov.io/gh/anthonyaxenov/atol-online/branch/dev/graph/badge.svg?token=WR2IV7FTF0)](https://codecov.io/gh/anthonyaxenov/atol-online) | - ## Плюшечки * Мониторинг ККТ и ФН -* Фискализация докумнетов на облачной ККТ +* Фискализация документов на облачной ККТ * Валидация данных до отправки документа на ККТ (насколько это возможно, согласно схеме) * Расчёты денег в копейках -* PSR-4 автозагрузка, покрытие настоящими тестами, fluent-setters +* PSR-4 автозагрузка, покрытие настоящими тестами, fluent-setters, докблоки ## Системные требования @@ -69,23 +63,16 @@ composer coverage # тестирование с покрытием После тестирования с покрытием создаётся отчёт в директории `.coverage` в корне репозитория. -## Использование библиотеки +### Использование библиотеки Весь исходный код находится в директории [`/src`](/src). +Вы имеете право использовать и распространять его на условиях **[лицензии MIT](LICENSE)**. -**Комментарии phpdoc есть буквально везде. Прокомментировано вообще всё.** - -1. Обращайтесь к [документации библиотеки](/docs). -2. Обращайтесь к [исходному коду](/src). -3. Обращайтесь к [тестам](/tests). -4. Используйте подсказки вашей IDE. - -Тогда у вас не возникнет затруднений. +1. Обращайтесь к [документации библиотеки](/docs) +2. Обращайтесь к [исходному коду](/src) и описанным докблокам +3. Обращайтесь к [тестам](/tests/AtolOnline/Tests) +4. Используйте нормальную IDE ## Дополнительные ресурсы * [Документация АТОЛ Онлайн](https://online.atol.ru/lib/) - -## Лицензия - -Вы имеете право использовать и распространят код из этого репозитория на условиях **[лицензии MIT](LICENSE)**.