Skip to content

Commit

Permalink
Changed README in markdown
Browse files Browse the repository at this point in the history
  • Loading branch information
ezimuel committed Nov 16, 2021
1 parent bdd8a9a commit 92b8161
Showing 1 changed file with 21 additions and 23 deletions.
44 changes: 21 additions & 23 deletions README.rst → README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
=======
RingPHP
=======

Expand All @@ -9,42 +8,41 @@ RingPHP
Provides a simple API and specification that abstracts away the details of HTTP
into a single PHP function. RingPHP be used to power HTTP clients and servers
through a PHP function that accepts a request hash and returns a response hash
that is fulfilled using a `promise <https://github.com/reactphp/promise>`_,
that is fulfilled using a [promise](https://github.com/reactphp/promise),
allowing RingPHP to support both synchronous and asynchronous workflows.

By abstracting the implementation details of different HTTP clients and
servers, RingPHP allows you to utilize pluggable HTTP clients and servers
without tying your application to a specific implementation.

.. code-block:: php
<?php
require 'vendor/autoload.php';
```php
require 'vendor/autoload.php';

use GuzzleHttp\Ring\Client\CurlHandler;
use GuzzleHttp\Ring\Client\CurlHandler;

$handler = new CurlHandler();
$response = $handler([
'http_method' => 'GET',
'uri' => '/',
'headers' => [
'host' => ['www.google.com'],
'x-foo' => ['baz']
]
]);
$handler = new CurlHandler();
$response = $handler([
'http_method' => 'GET',
'uri' => '/',
'headers' => [
'host' => ['www.google.com'],
'x-foo' => ['baz']
]
]);

$response->then(function (array $response) {
echo $response['status'];
});
$response->then(function (array $response) {
echo $response['status'];
});

$response->wait();
$response->wait();
```

RingPHP is inspired by Clojure's `Ring <https://github.com/ring-clojure/ring>`_,
RingPHP is inspired by Clojure's [Ring](https://github.com/ring-clojure/ring),
which, in turn, was inspired by Python's WSGI and Ruby's Rack. RingPHP is
utilized as the handler layer in `Guzzle <http://guzzlephp.org>`_ 5.0+ to send
utilized as the handler layer in [Guzzle](https://guzzlephp.org) 5.0+ to send
HTTP requests.

Documentation
-------------

See http://ringphp.readthedocs.org/ for the full online documentation.
See https://ringphp.readthedocs.io/en/latest/ for the full online documentation.

0 comments on commit 92b8161

Please sign in to comment.