Skip to content

Commit 5f4cd79

Browse files
committed
Add description to README.md
1 parent 3e59cec commit 5f4cd79

File tree

1 file changed

+41
-1
lines changed

1 file changed

+41
-1
lines changed

README.md

Lines changed: 41 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,43 @@
11
# HTTP Basis
22

3-
The repository is under development, and the description will appear later.
3+
[![License](https://poser.pugx.org/httpsoft/http-basis/license)](https://packagist.org/packages/httpsoft/http-basis)
4+
[![Latest Stable Version](https://poser.pugx.org/httpsoft/http-basis/v)](https://packagist.org/packages/httpsoft/http-basis)
5+
[![Total Downloads](https://poser.pugx.org/httpsoft/http-basis/downloads)](https://packagist.org/packages/httpsoft/http-basis)
6+
[![GitHub Build Status](https://github.com/httpsoft/http-basis/workflows/build/badge.svg)](https://github.com/httpsoft/http-basis/actions)
7+
[![GitHub Static Analysis Status](https://github.com/httpsoft/http-basis/workflows/static/badge.svg)](https://github.com/httpsoft/http-basis/actions)
8+
[![Scrutinizer Code Coverage](https://scrutinizer-ci.com/g/httpsoft/http-basis/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/httpsoft/http-basis/?branch=master)
9+
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/httpsoft/http-basis/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/httpsoft/http-basis/?branch=master)
10+
11+
This package is a simple and fast HTTP microframework implementing PHP standards recommendations.
12+
13+
* [PSR-3 Logger](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-3-logger-interface.md).
14+
* [PSR-7 HTTP Message](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-7-http-message.md).
15+
* [PSR-11 Container](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-11-container.md).
16+
* [PSR-12 Coding Style](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-12-extended-coding-style-guide.md).
17+
* [PSR-15 HTTP Server](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-15-request-handlers.md).
18+
* [PSR-17 HTTP Factories](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-17-http-factory.md).
19+
20+
This package helps you quickly create simple but high-quality web applications and APIs.
21+
22+
## Documentation
23+
24+
* [In English language](https://httpsoft.org/docs/basis).
25+
* [In Russian language](https://httpsoft.org/ru/docs/basis).
26+
27+
## Installation
28+
29+
This package requires PHP version 7.4 or later.
30+
31+
To create the project you can use a ready-made [application template](https://github.com/httpsoft/http-app):
32+
33+
```bash
34+
composer create-project --prefer-dist httpsoft/http-app <app-dir>
35+
```
36+
37+
or install a microframework:
38+
39+
```bash
40+
composer require httpsoft/http-basis
41+
```
42+
43+
and configure everything manually, see the [documentation](https://httpsoft.org/docs/basis) for more details.

0 commit comments

Comments
 (0)