Update README.md

Author: Pranjal Pandey

README.md

@@ -1,3 +1,71 @@
 # Swoole Coroutine PostgreSQL Doctrine DBAL Driver
 
-Fork of https://github.com/leocavalcante/swoole-postgresql-doctrine-driver to be used within Project Arca
+A `Doctrine\DBAL\Driver` implementation on top of `Swoole\Coroutine\PostgreSQL`.
+Requires ext-openswoole 4.7.1 or higher
+
+## Getting started
+
+### Install
+
+```shell
+composer require scrawler/swoole-postgresql-doctrine
+```
+
+### Usage
+
+Doctrine parameters, for both DBAL and ORM projects, accepts the `driverClass` option; it is where we can inject this project's driver:
+
+```php
+use Doctrine\DBAL\{Driver, DriverManager};
+
+$params = [
+    'dbname' => 'postgres',
+    'user' => 'postgres',
+    'password' => 'postgres',
+    'host' => 'db',
+    'driverClass' =>\Scrawler\Swoole\PostgreSQL\Driver::class,
+    'poolSize' => 8,
+];
+
+$conn = DriverManager::getConnection($params);
+```
+
+
+#### You are ready to rock inside Coroutines (Fibers):
+
+```php
+Co\run(static function() use ($conn): void {
+    $results = [];
+    $wg = new Co\WaitGroup();
+    $start_time = time();
+
+    Co::create(static function() use (&$results, $wg, $conn): void {
+        $wg->add();
+        $results[] = $conn->executeQuery('select 1, pg_sleep(1)')->fetchOne();
+        $wg->done();
+    });
+
+    Co::create(static function() use (&$results, $wg, $conn): void {
+        $wg->add();
+        $results[] = $conn->executeQuery('select 1, pg_sleep(1)')->fetchOne();
+        $wg->done();
+    });
+
+    $wg->wait();
+    $elapsed = time() - $start_time;
+    $sum = array_sum($results);
+
+    echo "Two pg_sleep(1) queries in $elapsed second, returning: $sum\n";
+});
+```
+
+You should be seeing `Two pg_sleep(1) queries in 1 second, returning: 2` and the total time should **not** be 2 (the sum of `pg_sleep(1)`'s) because they ran concurrently.
+
+```shell
+real    0m1.228s
+user    0m0.036s
+sys     0m0.027s
+```
+
+
+This Project has been possible because of  https://github.com/leocavalcante/swoole-postgresql-doctrine-driver