Merge pull request #3 from mgcostaParedes/readme-1#

fix: readme update #1

.travis.yml

@@ -0,0 +1,21 @@
+language: php
+
+php:
+  - 7.3
+
+env:
+  global:
+    - XDEBUG_MODE=coverage
+
+before_script:
+  - pecl install grpc
+  - pecl install protobuf
+  - echo "extension=grpc.so" >> ~/.phpenv/versions/$(phpenv version-name)/etc/php.ini
+  - echo "extension=protobuf.so" >> ~/.phpenv/versions/$(phpenv version-name)/etc/php.ini
+  - composer install
+
+script:
+  - php vendor/bin/codecept run --coverage --coverage-text --coverage-xml
+
+after_success:
+  - bash <(curl -s https://codecov.io/bash)

README.md

@@ -1,3 +1,38 @@
 ## Spanner ORM Builder
 
-The Spanner ORM Builder is a database toolkit to PHP, providing an expressive query builder, ActiveRecord style ORM, it can serve as a database layer for your PHP app if you intend to work with **Google Cloud Spanner**.
+[![Build Status](https://travis-ci.com/mgcostaParedes/spanner-orm-builder.svg?branch=main)](https://travis-ci.com/mgcostaParedes/spanner-orm-builder)
+[![codecov](https://codecov.io/gh/mgcostaParedes/spanner-orm-builder/branch/main/graph/badge.svg?token=OEUY7ZDTOP)](https://codecov.io/gh/mgcostaParedes/spanner-orm-builder)
+
+The Spanner ORM Builder is a database toolkit to PHP, providing an expressive query builder, ActiveRecord style ORM, it can serve as a database layer for your PHP app if you intend to work with **Google Cloud Spanner**.
+
+### Usage Instructions
+
+First, we should create a new "Manager" instance. Manager aims to make configuring the library for every framework as easy as possible.
+
+```PHP
+
+use MgCosta\Spanner\Manager;
+use Google\Cloud\Spanner\Database;
+
+// $database = your database instance for google cloud spanner;
+
+$manager = new Manager($database);
+$manager->boot();
+
+```
+
+That's it, you're ready to use the library, just be sure to instantiate the manager as soon as possible on your APP, usually on your bootstrap or config file.
+
+Once the Manager instance has been registered, we may use it like:
+
+**Using The Query Builder**
+
+```PHP
+
+class User extends \MgCosta\Spanner\Model\Model {}
+
+$users = User::where('age', '>', 30)->get();
+
+```
+
+The implementation of the query builder is inspired on Laravel Query Builder, to get more documentation follow the [link](https://laravel.com/docs/master/queries).