update README
[m6w6/ext-http] / README.md
1 # ext-http
2
3 [![Build Status](https://github.com/m6w6/ext-http/workflows/ci/badge.svg?branch=master)](https://github.com/m6w6/ext-http/actions?query=workflow%3Aci+branch%3Amaster)
4 [![Coverity Scan Build Status](https://scan.coverity.com/projects/8711/badge.svg)](https://scan.coverity.com/projects/m6w6-ext-http)
5 [![codecov](https://codecov.io/gh/m6w6/ext-http/branch/master/graph/badge.svg)](https://codecov.io/gh/m6w6/ext-http)
6
7 Extended HTTP support for PHP.
8
9 ## Branches and Versions:
10
11 > **NOTE:**
12 Use `v3.x` branch, and resp. v3 releases, for PHP-7. `master` and v4 releases are only for PHP-8.
13
14
15 ## Documentation
16
17 See the [online markdown reference](https://mdref.m6w6.name/http).
18
19 Known issues are listed in [BUGS](./BUGS) and future ideas can be found in [TODO](./TODO).
20
21 ## Install
22
23 ### PECL
24
25 pecl install pecl_http
26
27 ### PHARext
28
29 Watch out for [PECL replicates](https://replicator.pharext.org?pecl_http)
30 and pharext packages attached to [releases](https://github.com/m6w6/ext-http/releases).
31
32 ### Checkout
33
34 git clone https://github.com/m6w6/ext-http.git
35 cd ext-http
36 /path/to/phpize
37 ./configure --with-php-config=/path/to/php-config
38 make
39 sudo make install
40
41 ## ChangeLog
42
43 A comprehensive list of changes can be obtained from the [ChangeLog](./CHANGELOG.md) and the list of [fixed CVEs](./CVE.md).
44
45 ## License
46
47 ext-http is licensed under the 2-Clause-BSD license, which can be found in
48 the accompanying [LICENSE](./LICENSE) file.
49
50 ## Contributing
51
52 All forms of contribution are welcome! Please see the bundled
53 [CONTRIBUTING](./CONTRIBUTING.md) note for the general principles followed.
54
55 The list of past and current contributors is maintained in [THANKS](./THANKS).