Updated documentation 📖

Author: grimzy

README.md

@@ -15,6 +15,8 @@ Please check the documentation for your MySQL version. MySQL's Extension for Spa
 - `1.x.x`: MySQL 5.6 (also supports MySQL 5.5 but not all spatial analysis functions)
 - `2.x.x`: MySQL 5.7 and 8.0
 
+This package also works with MariaDB. Please refer to the [MySQL/MariaDB Spatial Support Matrix](https://mariadb.com/kb/en/library/mysqlmariadb-spatial-support-matrix/) for compatibility.
+
 [TOC]
 
 ## Installation
@@ -42,8 +44,6 @@ For Laravel versions before 5.5 or if not using auto-discovery, register the ser
 ],
 ```
 
-
-
 ## Quickstart
 
 ### Create a migration
@@ -75,6 +75,8 @@ class CreatePlacesTable extends Migration {
             $table->string('name')->unique();
             // Add a Point spatial data field named location
             $table->point('location')->nullable();
+            // Add a Polygon spatial data field named area
+            $table->polygon('area')->nullable();
             $table->timestamps();
         });
     }
@@ -121,22 +123,40 @@ class Place extends Model
     use SpatialTrait;
 
     protected $fillable = [
-        'name',
+        'name'
     ];
 
     protected $spatialFields = [
         'location',
+        'area'
     ];
 }
 ```
 
 ### Saving a model
 
 ```php
+use Grimzy\LaravelMysqlSpatial\Types\Point;
+use Grimzy\LaravelMysqlSpatial\Types\Polygon;
+
 $place1 = new Place();
 $place1->name = 'Empire State Building';
-$place1->location = new Point(40.7484404, -73.9878441);
+
+// saving a point
+$place1->location = new Point(40.7484404, -73.9878441);	// (lat, lng)
 $place1->save();
+
+// saving a polygon
+$place1->area = new Polygon([new LineString([
+    new Point(40.74894149554006, -73.98615270853043),
+    new Point(40.74848633046773, -73.98648262023926),
+    new Point(40.747925497790725, -73.9851602911949),
+    new Point(40.74837050671544, -73.98482501506805),
+    new Point(40.74894149554006, -73.98615270853043)
+])]);
+
+$place1->area = new Polygon();
+
 ```
 
 ### Retrieving a model
@@ -147,8 +167,6 @@ $lat = $place2->location->getLat();	// 40.7484404
 $lng = $place2->location->getLng();	// -73.9878441
 ```
 
-
-
 ## Migrations
 
 ### Columns
@@ -177,7 +195,7 @@ Note about spatial indexes from the [MySQL documentation](https://dev.mysql.com/
 
 > For [`MyISAM`](https://dev.mysql.com/doc/refman/5.7/en/myisam-storage-engine.html) and (as of MySQL 5.7.5) `InnoDB` tables, MySQL can create spatial indexes using syntax similar to that for creating regular indexes, but using the `SPATIAL` keyword. Columns in spatial indexes must be declared `NOT NULL`.
 
-Following the example in the [Quickstart](#user-content-create-a-migration); from the command line:
+For example, as a follow up to the [Quickstart](#user-content-create-a-migration); from the command line, generate a new migration:
 
 ```shell
 php artisan make:migration update_places_table
@@ -231,8 +249,6 @@ class UpdatePlacesTable extends Migration
 }
 ```
 
-
-
 ## Geometry classes
 
 ### Available Geometry classes
@@ -247,6 +263,8 @@ class UpdatePlacesTable extends Migration
 | `MultiPolygon(Polygon[])`                | [MultiPolygon](https://dev.mysql.com/doc/refman/5.7/en/gis-class-multipolygon.html) |
 | `GeometryCollection(Geometry[])`         | [GeometryCollection](https://dev.mysql.com/doc/refman/5.7/en/gis-class-geometrycollection.html) |
 
+Check out the [Class diagram](https://user-images.githubusercontent.com/1837678/30788608-a5afd894-a16c-11e7-9a51-0a08b331d4c4.png).
+
 ### Using Geometry classes
 
 In order for your Eloquent Model to handle the Geometry classes, it must use the `Grimzy\LaravelMysqlSpatial\Eloquent\SpatialTrait` trait and define a `protected` property `$spatialFields`  as an array of MySQL Spatial Data Type column names (example in [Quickstart](#user-content-create-a-model)).
@@ -267,7 +285,7 @@ for($polygon as $i => $linestring) {
 
 #### Helpers
 
-##### From/To Well Kown Text ([WKT](https://dev.mysql.com/doc/refman/5.7/en/gis-data-formats.html#gis-wkt-format))
+##### From/To Well Known Text ([WKT](https://dev.mysql.com/doc/refman/5.7/en/gis-data-formats.html#gis-wkt-format))
 
 ```php
 $polygon = Polygon::fromWKT('POLYGON((0 0,4 0,4 4,0 4,0 0),(1 1, 2 1, 2 2, 1 2,1 1))');
@@ -291,29 +309,26 @@ The Geometry classes implement [`JsonSerializable`](http://php.net/manual/en/cla
 ```php
 $point = new Point(10, 20);
 
-json_encode($point);
-// or
-$point->toJson();
-```
-
-Returns:
-
-```javascript
-{
-  "type": "Feature",
-  "properties": {},
-  "geometry": {
-    "type": "Point",
-    "coordinates": [
-      -73.9878441,
-      40.7484404
-    ]
-  }
-}
+json_encode($point); // or $point->toJson();
+
+// {
+//   "type": "Feature",
+//   "properties": {},
+//   "geometry": {
+//     "type": "Point",
+//     "coordinates": [
+//       -73.9878441,
+//       40.7484404
+//     ]
+//   }
+// }
+
+$locaction = Geometry::fromJson('{"type":"Point","coordinates":[3.4,1.2]}');
+$location instanceof Point::class;	// true
+$location->getLat();	// 1.2
+$location->getLng()); 	// 3.4
 ```
 
-##### 
-
 ## Scopes: Spatial analysis functions
 
 Spatial analysis functions are implemented using [Eloquent Local Scopes](https://laravel.com/docs/5.4/eloquent#local-scopes).
@@ -336,8 +351,6 @@ Available scopes:
 
 *Note that behavior and availability of MySQL spatial analysis functions differs in each MySQL version (cf. [documentation](https://dev.mysql.com/doc/refman/5.7/en/spatial-function-reference.html)).*
 
-
-
 ## Credits
 
 Originally inspired from [njbarrett's Laravel postgis package](https://github.com/njbarrett/laravel-postgis).