Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
jjcfrancisco committed Jul 24, 2024
1 parent 21b4547 commit 873725b
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ popgis --help
```

## Usage
`input`, `uri` & `table` are required; `schema` & `srid` are optional.
Below are the available commands and flags for Popgis.

#### Flags

Expand All @@ -35,7 +35,7 @@ popgis --help

`srid`: choose either 4326 (WGS84) or 3857 (Web Mercator). **Optional**. *Default is 4326.*

`mode`: choose either **overwrite**, **append** or **fail** modes. Read more [here](#modes).
`mode` (short: `-m`): choose either **overwrite**, **append** or **fail** modes. Read more [here](#modes).

#### Examples
```bash
Expand All @@ -51,6 +51,7 @@ popgis -i water_polygons.shp \
-u postgresql://my_username:my_password@localhost:5432/my_database \
-s osm \
-t waters
-m overwrite
```

#### Modes
Expand Down Expand Up @@ -80,12 +81,12 @@ Although non extensive, the benchmarking shows **Popgis is twice faster than ogr
## Future implementation
The list below contains the upcoming implementations.

To do:

* Project from 4326 to 3857 (and viceversa).
* Allow nested GeoJSON properties.
* <del>Improve stdout.</del>
* <del>Modes: create, overwrite & append.</del>
* <del>Allow GeoJSON as input.</del>
* Reduce precision of a GeoJSON file.
* New validate command to validate files.
* Merge two columns of different types.


## License
See [`LICENSE`](./LICENSE)

0 comments on commit 873725b

Please sign in to comment.