From 95b1d084ab77d1c57f167395f158ededb1f50a5a Mon Sep 17 00:00:00 2001 From: Ryan Paiva Date: Tue, 22 Apr 2025 16:05:31 -0400 Subject: [PATCH] Added TOC. Removed 1.x trait reference in 2.x docs. Added section/link to the upgrade guide. --- README.md | 36 +++++++++++++++++++++++++++++++++++- 1 file changed, 35 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index fea3232..a8f3cf6 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,37 @@
+- [Introduction](#introduction) +- [Requirements](#requirements) +- [Installation](#installation) +- [Upgrading from 1.x to 2.x](#upgrading-from-1x-to-2x) +- [What's included](#whats-included) +- [Before you start](#before-you-start) +- [Creating Tables with PostGIS Columns](#creating-tables-with-postgis-columns) +- [Preparing the Model](#preparing-the-model) +- [Using the geometry data classes](#using-the-geometry-data-classes) +- [Generators \& Parsers](#generators--parsers) +- [Request Validation and Transformation](#request-validation-and-transformation) +- [Interaction with the database](#interaction-with-the-database) + - [Example Setup](#example-setup) + - [Insert/Update](#insertupdate) + - [Insert/Update with different SRID](#insertupdate-with-different-srid) + - [Select](#select) + - [Using PostGIS functions in queries](#using-postgis-functions-in-queries) + - [Alias in select](#alias-in-select) + - [Geometry or Geography](#geometry-or-geography) + - [Autocast for BBox or geometries](#autocast-for-bbox-or-geometries) +- [Limitations](#limitations) + - [Database Name Prepending (Cross Database Connections)](#database-name-prepending-cross-database-connections) +- [Testing](#testing) +- [Changelog](#changelog) +- [Contributing](#contributing) +- [Security Vulnerabilities](#security-vulnerabilities) +- [Thanks](#thanks) +- [Credits](#credits) +- [License](#license) + + ## Introduction Every sailor needs a nice ship to travel the seven seas ⛵️ @@ -67,6 +98,10 @@ php artisan vendor:publish --tag="magellan-config" You may find the contents of the published config file here: [config/magellan.php](config/magellan.php) +## Upgrading from 1.x to 2.x + +Please see [UPGRADING](UPGRADING.md) for details. + ## What's included - [x] Migration Schema Blueprints @@ -270,7 +305,6 @@ and the model implementation: class Port extends Model { use HasFactory; - use HasPostgisColumns; protected $guarded = [];