Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@asinghvi17
asinghvi17 authored Apr 27, 2024
1 parent 35c8d42 commit 69bad03
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
[![CI](https://github.com/JuliaGeo/Shapefile.jl/workflows/CI/badge.svg)](https://github.com/JuliaGeo/Shapefile.jl/actions?query=workflow%3ACI)
[![codecov](https://codecov.io/gh/JuliaGeo/Shapefile.jl/branch/master/graph/badge.svg?token=pRKEwKkeTk)](https://codecov.io/gh/JuliaGeo/Shapefile.jl)

This library supports reading and writing ESRI Shapefiles in pure Julia.
This library supports reading and writing ESRI Shapefiles in pure Julia, as well as `.zip` files that contain shapefiles.

## Quick Start
Basic example of reading a shapefile from test cases:
Expand Down Expand Up @@ -49,6 +49,10 @@ julia> GeoInterface.coordinates(Shapefile.shape(first(table)))
[[[0.0, 0.0], [100.0, 0.0], [100.0, 100.0], [0.0, 100.0], [0.0, 0.0]]]
```

## Reading zipped shapefiles

Shapefiles that are compressed into a `.zip` file can be read by `Shapefile.Table` if you load the `ZipFile` library first.

## Alternative packages

If you want another lightweight pure Julia package for reading feature files, consider
Expand Down

2 comments on commit 69bad03

@asinghvi17
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator register

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request created: JuliaRegistries/General/105719

Tip: Release Notes

Did you know you can add release notes too? Just add markdown formatted text underneath the comment after the text
"Release notes:" and it will be added to the registry PR, and if TagBot is installed it will also be added to the
release that TagBot creates. i.e.

@JuliaRegistrator register

Release notes:

## Breaking changes

- blah

To add them here just re-invoke and the PR will be updated.

Tagging

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.13.0 -m "<description of version>" 69bad032c3caef938c5f020ba39107e53a7ac593
git push origin v0.13.0

Please sign in to comment.