Skip to content

Commit fdb6ec6

Browse files
Merge pull request #122 from developmentseed/docs/update-readme
2 parents 1fc3b73 + 557cdbe commit fdb6ec6

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525

2626
---
2727

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.
2929

3030
> **Note**
3131
> This project is the result of the merge between [tifeatures](https://github.com/developmentseed/tifeatures) and [timvt](https://github.com/developmentseed/timvt).
@@ -55,13 +55,13 @@ OGC Tiles Part 1: Core | ✅ | https://docs.ogc.org/is/20-057/2
5555

5656
Notes:
5757

58-
The project authors choose not to implement the Part 2 of the specification to avoid the introduction of CRS based 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.
5959

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).
6161

6262
## PostGIS/PostgreSQL
6363

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.
6565

6666
```sql
6767
SELECT name, default_version,installed_version
@@ -74,23 +74,23 @@ CREATE EXTENSION postgis;
7474

7575
### Configuration
7676

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.
7878

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)
8080

8181
```
82-
# you need define the DATABASE_URL directly
82+
# you need to define the DATABASE_URL directly
8383
DATABASE_URL=postgresql://username:[email protected]:5432/postgis
8484
```
8585

86-
More info about configuration options in https://developmentseed.org/tipg/advanced/configuration/
86+
More info about configuration options at https://developmentseed.org/tipg/user_guide/configuration/
8787

8888
## Launch
8989

9090
```bash
9191
$ pip install uvicorn
9292

93-
# Set your postgis database instance URL in the environment
93+
# Set your PostGIS database instance URL in the environment
9494
$ export DATABASE_URL=postgresql://username:[email protected]:5432/postgis
9595
$ uvicorn tipg.main:app
9696

0 commit comments

Comments
 (0)