Исправлен README
This commit is contained in:
41
README.md
41
README.md
@@ -1,13 +1,13 @@
|
|||||||
# АТОЛ Онлайн
|
# АТОЛ Онлайн
|
||||||
|
|
||||||
[](https://packagist.org/packages/axenov/atol-online)
|
|
||||||
[](https://packagist.org/packages/axenov/atol-online)
|
|
||||||
[](https://packagist.org/packages/axenov/atol-online)
|
|
||||||
[](https://packagist.org/packages/axenov/atol-online)
|
|
||||||
[](LICENSE)
|
|
||||||
|
|
||||||
Библиотека для фискализации чеков по 54-ФЗ через [облачные ККТ АТОЛ](https://online.atol.ru/).
|
Библиотека для фискализации чеков по 54-ФЗ через [облачные ККТ АТОЛ](https://online.atol.ru/).
|
||||||
|
|
||||||
|
[](https://github.com/anthonyaxenov/atol-online/actions/workflows/ci.yml)
|
||||||
|
[](https://codecov.io/gh/anthonyaxenov/atol-online)
|
||||||
|
[](https://packagist.org/packages/axenov/atol-online)
|
||||||
|
[](https://packagist.org/packages/axenov/atol-online)
|
||||||
|
[](LICENSE)
|
||||||
|
|
||||||
**[Документация](/docs/readme.md)**
|
**[Документация](/docs/readme.md)**
|
||||||
|
|
||||||
Текущие поддерживаемые версии АТОЛ Онлайн:
|
Текущие поддерживаемые версии АТОЛ Онлайн:
|
||||||
@@ -17,19 +17,13 @@
|
|||||||
| v4 | 5.8 | 1.05 | Поддерживается |
|
| v4 | 5.8 | 1.05 | Поддерживается |
|
||||||
| v5 | 2.0 | 1.2 | В планах |
|
| v5 | 2.0 | 1.2 | В планах |
|
||||||
|
|
||||||
Состояние веток:
|
|
||||||
|
|
||||||
| master | [](https://github.com/anthonyaxenov/atol-online/actions/workflows/ci.yml) | [](https://codecov.io/gh/anthonyaxenov/atol-online) |
|
|
||||||
|--------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
||||||
| dev | [](https://github.com/anthonyaxenov/atol-online/actions/workflows/ci.yml) | [](https://codecov.io/gh/anthonyaxenov/atol-online) |
|
|
||||||
|
|
||||||
## Плюшечки
|
## Плюшечки
|
||||||
|
|
||||||
* Мониторинг ККТ и ФН
|
* Мониторинг ККТ и ФН
|
||||||
* Фискализация докумнетов на облачной ККТ
|
* Фискализация документов на облачной ККТ
|
||||||
* Валидация данных до отправки документа на ККТ (насколько это возможно, согласно схеме)
|
* Валидация данных до отправки документа на ККТ (насколько это возможно, согласно схеме)
|
||||||
* Расчёты денег в копейках
|
* Расчёты денег в копейках
|
||||||
* PSR-4 автозагрузка, покрытие настоящими тестами, fluent-setters
|
* PSR-4 автозагрузка, покрытие настоящими тестами, fluent-setters, докблоки
|
||||||
|
|
||||||
## Системные требования
|
## Системные требования
|
||||||
|
|
||||||
@@ -69,23 +63,16 @@ composer coverage # тестирование с покрытием
|
|||||||
|
|
||||||
После тестирования с покрытием создаётся отчёт в директории `.coverage` в корне репозитория.
|
После тестирования с покрытием создаётся отчёт в директории `.coverage` в корне репозитория.
|
||||||
|
|
||||||
## Использование библиотеки
|
### Использование библиотеки
|
||||||
|
|
||||||
Весь исходный код находится в директории [`/src`](/src).
|
Весь исходный код находится в директории [`/src`](/src).
|
||||||
|
Вы имеете право использовать и распространять его на условиях **[лицензии MIT](LICENSE)**.
|
||||||
|
|
||||||
**Комментарии phpdoc есть буквально везде. Прокомментировано вообще всё.**
|
1. Обращайтесь к [документации библиотеки](/docs)
|
||||||
|
2. Обращайтесь к [исходному коду](/src) и описанным докблокам
|
||||||
1. Обращайтесь к [документации библиотеки](/docs).
|
3. Обращайтесь к [тестам](/tests/AtolOnline/Tests)
|
||||||
2. Обращайтесь к [исходному коду](/src).
|
4. Используйте нормальную IDE
|
||||||
3. Обращайтесь к [тестам](/tests).
|
|
||||||
4. Используйте подсказки вашей IDE.
|
|
||||||
|
|
||||||
Тогда у вас не возникнет затруднений.
|
|
||||||
|
|
||||||
## Дополнительные ресурсы
|
## Дополнительные ресурсы
|
||||||
|
|
||||||
* [Документация АТОЛ Онлайн](https://online.atol.ru/lib/)
|
* [Документация АТОЛ Онлайн](https://online.atol.ru/lib/)
|
||||||
|
|
||||||
## Лицензия
|
|
||||||
|
|
||||||
Вы имеете право использовать и распространят код из этого репозитория на условиях **[лицензии MIT](LICENSE)**.
|
|
||||||
|
|||||||
Reference in New Issue
Block a user