You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+9-9Lines changed: 9 additions & 9 deletions
Original file line number
Diff line number
Diff line change
@@ -25,7 +25,7 @@
25
25
26
26
---
27
27
28
-
`tipg`, pronounced *T[ee]pg*, is a **python** package which helps creating lightweight OGC **Features** and **Tiles** API with PostGIS Database backend. The API has been designed with respect to[OGC Features](https://ogcapi.ogc.org/features) and [OGC Tiles](https://ogcapi.ogc.org/tiles/) specifications.
28
+
`tipg`, pronounced *T[ee]pg*, is a **Python** package that helps create lightweight OGC **Features** and **Tiles** API with a PostGIS Database backend. The API has been designed for[OGC Features](https://ogcapi.ogc.org/features) and [OGC Tiles](https://ogcapi.ogc.org/tiles/) specifications.
29
29
30
30
> **Note**
31
31
> This project is the result of the merge between [tifeatures](https://github.com/developmentseed/tifeatures) and [timvt](https://github.com/developmentseed/timvt).
The project authors choose not to implement the Part 2 of the specification to avoid the introduction of CRSbased GeoJSON. This might change in the future.
58
+
We chose to avoid implementing the second part of the specification to prevent the introduction of CRS-based GeoJSON. We may review this decision in the future.
59
59
60
-
While the authors tried to follow OGC specifications to the letter, some API endpoints might have more capabilities (e.g geometry column selection).
60
+
While we tried to follow OGC specifications to the letter, some API endpoints might have more capabilities (e.g., geometry column selection).
61
61
62
62
## PostGIS/PostgreSQL
63
63
64
-
`tipg`rely a lot of`ST_*`PostGIS functions. You need to make sure your PostgreSQL database has PostGIS installed.
64
+
`tipg`relies greatly on PostGIS'`ST_*` functions. PostGIS must be installed on your PostgreSQL database.
65
65
66
66
```sql
67
67
SELECT name, default_version,installed_version
@@ -74,23 +74,23 @@ CREATE EXTENSION postgis;
74
74
75
75
### Configuration
76
76
77
-
To be able to work, the application will need access to the database. `tipg` uses [starlette](https://www.starlette.io/config/)'s configuration pattern which make use of environment variable and/or `.env` file to pass variable to the application.
77
+
To be able to work, the application will need access to the database. `tipg` uses [Starlette](https://www.starlette.io/config/)'s configuration pattern, which makes use of environment variables or a `.env` file to pass variables to the application.
78
78
79
-
Example of`.env` file can be found in [.env.example](https://github.com/developmentseed/tipg/blob/main/.env.example)
79
+
An example of a`.env` file can be found in [.env.example](https://github.com/developmentseed/tipg/blob/main/.env.example)
0 commit comments