Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
jjcfrancisco committed Jul 7, 2024
1 parent f38097f commit c127d1a
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 1 deletion.
31 changes: 30 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,31 @@
# popgis
Blazing fast ingestion of ShapeFile & GeoJSON into a PostGIS database
A blazing fast way to insert Shapefiles & GeoJSON into a PostGIS database.

## Install
*Upcoming...*

## Usage
Required flags are `input`, `uri` & `table`.

1. Use the **input** flag to choose the *shapefile* or *geojson* file to insert into a PostGIS database.
2. Use the **uri** flag to tell `popgis` the PostGIS database where you'd like to insert the input data.
3. The **table** flag is for choosing the name of the resulting table.

## Examples
*Upcoming...*

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

## Benchmarks
*Upcoming...*

## Limitations
Currently, only ShapeFile files are implemented.

## Future implementation
The list below contains the upcoming implementations.

To do:

* Allow GeoJSON as input.
Empty file added src/file_types/geojson.rs
Empty file.
1 change: 1 addition & 0 deletions src/file_types/mod.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
pub mod common;
mod geo;
pub mod shapefile;
pub mod geojson;

0 comments on commit c127d1a

Please sign in to comment.