add API.md file

Author: MatanYadaev

API.md

@@ -0,0 +1,43 @@
+# API
+
+## Available spatial classes
+
+* `Point(float $latitude, float $longitude)` - [MySQL Point](https://dev.mysql.com/doc/refman/8.0/en/gis-class-point.html)
+* `MultiPoint(Point[] | Collection<Point>)` - [MySQL MultiPoint](https://dev.mysql.com/doc/refman/8.0/en/gis-class-multipoint.html)
+* `LineString(Point[] | Collection<Point>)` - [MySQL LineString](https://dev.mysql.com/doc/refman/8.0/en/gis-class-linestring.html)
+* `MultiLineString(LineString[] | Collection<LineString>)` - [MySQL MultiLineString](https://dev.mysql.com/doc/refman/8.0/en/gis-class-multilinestring.html)
+* `Polygon(LineString[] | Collection<LineString>)` - [MySQL Polygon](https://dev.mysql.com/doc/refman/8.0/en/gis-class-polygon.html)
+* `MultiPolygon(Polygon[] | Collectiogit n<Polygon>)` - [MySQL MultiPolygon](https://dev.mysql.com/doc/refman/8.0/en/gis-class-multipolygon.html)
+* `GeometryCollection(Geometry[] | Collection<Geometry>)` - [MySQL GeometryCollection](https://dev.mysql.com/doc/refman/8.0/en/gis-class-geometrycollection.html)
+
+## Available spatial functions
+
+* `toWkt` - Mostly used internally
+* `toArray`
+* `toJson`
+* `fromWkb` - Mostly used internally
+* `fromJson`
+* `toFeatureCollectionJson`
+* `getCoordinates`
+
+Geometry collection functions:
+
+* `toCollectionWkt` - Mostly used internally
+* `getGeometries` - (explanation...) Can be used with `ArrayAccess` as well
+
+## Available spatial scopes
+
+* `withDistance(string $column, Geometry | string $geometryOrColumn, string $alias = 'distance')`
+* `whereDistance(string $column, Geometry | string $geometryOrColumn, string $operator, int | float $distance)`
+* `orderByDistance(string $column, Geometry | string $geometryOrColumn, string $direction = 'asc')`
+* `withDistanceSphere(string $column, Geometry | string $geometryOrColumn, string $alias = 'distance')`
+* `whereDistanceSphere(string $column, Geometry | string $geometryOrColumn, string $operator, int | float $distance)`
+* `orderByDistanceSphere(string $column, Geometry | string $geometryOrColumn, string $direction = 'asc')`
+* `whereWithin(string $column, Geometry | string $geometryOrColumn)`
+* `whereContains(string $column, Geometry | string $geometryOrColumn)`
+* `whereTouches(string $column, Geometry | string $geometryOrColumn)`
+* `whereIntersects(string $column, Geometry | string $geometryOrColumn)`
+* `whereCrosses(string $column, Geometry | string $geometryOrColumn)`
+* `whereDisjoint(string $column, Geometry | string $geometryOrColumn)`
+* `whereOverlaps(string $column, Geometry | string $geometryOrColumn)`
+* `whereEquals(string $column, Geometry | string $geometryOrColumn)`

readme.md renamed to README.md

@@ -133,47 +133,7 @@ echo $vacationCity->area->toJson(); // {"type":"Polygon","coordinates":[[[41.907
 
 ## API
 
-### Available spatial classes
-
-* `Point(float $latitude, float $longitude)` - [MySQL Point](https://dev.mysql.com/doc/refman/8.0/en/gis-class-point.html)
-* `MultiPoint(Point[] | Collection<Point>)` - [MySQL MultiPoint](https://dev.mysql.com/doc/refman/8.0/en/gis-class-multipoint.html)
-* `LineString(Point[] | Collection<Point>)` - [MySQL LineString](https://dev.mysql.com/doc/refman/8.0/en/gis-class-linestring.html)
-* `MultiLineString(LineString[] | Collection<LineString>)` - [MySQL MultiLineString](https://dev.mysql.com/doc/refman/8.0/en/gis-class-multilinestring.html)
-* `Polygon(LineString[] | Collection<LineString>)` - [MySQL Polygon](https://dev.mysql.com/doc/refman/8.0/en/gis-class-polygon.html)
-* `MultiPolygon(Polygon[] | Collection<Polygon>)` - [MySQL MultiPolygon](https://dev.mysql.com/doc/refman/8.0/en/gis-class-multipolygon.html)
-* `GeometryCollection(Geometry[] | Collection<Geometry>)` - [MySQL GeometryCollection](https://dev.mysql.com/doc/refman/8.0/en/gis-class-geometrycollection.html)
-  
-### Available spatial functions
-
-* `toWkt` - Mostly used internally
-* `toArray`
-* `toJson`
-* `fromWkb` - Mostly used internally
-* `fromJson`
-* `toFeatureCollectionJson`
-* `getCoordinates`
-
-Geometry collection functions:
-
-* `toCollectionWkt` - Mostly used internally
-* `getGeometries` - (explanation...) Can be used with `ArrayAccess` as well
-
-### Available spatial scopes
-
-* `withDistance(string $column, Geometry | string $geometryOrColumn, string $alias = 'distance')`
-* `whereDistance(string $column, Geometry | string $geometryOrColumn, string $operator, int | float $distance)`
-* `orderByDistance(string $column, Geometry | string $geometryOrColumn, string $direction = 'asc')`
-* `withDistanceSphere(string $column, Geometry | string $geometryOrColumn, string $alias = 'distance')`
-* `whereDistanceSphere(string $column, Geometry | string $geometryOrColumn, string $operator, int | float $distance)`
-* `orderByDistanceSphere(string $column, Geometry | string $geometryOrColumn, string $direction = 'asc')`
-* `whereWithin(string $column, Geometry | string $geometryOrColumn)`
-* `whereContains(string $column, Geometry | string $geometryOrColumn)`
-* `whereTouches(string $column, Geometry | string $geometryOrColumn)`
-* `whereIntersects(string $column, Geometry | string $geometryOrColumn)`
-* `whereCrosses(string $column, Geometry | string $geometryOrColumn)`
-* `whereDisjoint(string $column, Geometry | string $geometryOrColumn)`
-* `whereOverlaps(string $column, Geometry | string $geometryOrColumn)`
-* `whereEquals(string $column, Geometry | string $geometryOrColumn)`
+Please see [API](API.md) for more informative API documentation.
 
 ## Tip for better IDE support