Skip to content

Commit

Permalink
Merge pull request #4 from JuliaEarth/readme-example
Browse files Browse the repository at this point in the history 
Add an example to README
  • Loading branch information
@eliascarv
eliascarv authored Dec 4, 2024
2 parents f4f4922 + 42bd52a commit af2610a
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,25 @@ Get the latest stable release with Julia's package manager:
] add CoordGridTransforms
```

## Usage

To use the conversions defined in CoordGridTransforms.jl,
use it together with CoordRefSystems.jl in the same environment:

```julia
julia> using CoordRefSystems, CoordGridTransforms

julia> c = LatLon{SAD96}(-15, -45)
GeodeticLatLon{SAD96} coordinates
├─ lat: -15.0°
└─ lon: -45.0°

julia> convert(LatLon{SIRGAS2000}, c)
GeodeticLatLon{SIRGAS2000} coordinates
├─ lat: -15.000451566492272°
└─ lon: -45.00042666174454°
```

[build-img]: https://img.shields.io/github/actions/workflow/status/JuliaEarth/CoordGridTransforms.jl/CI.yml?branch=main&style=flat-square
[build-url]: https://github.com/JuliaEarth/CoordGridTransforms.jl/actions

Expand Down

2 comments on commit af2610a

@eliascarv
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 updated: JuliaRegistries/General/120627

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.1.0 -m "<description of version>" af2610a6598226e7eddfe2f71ed3634426bf8ca0
git push origin v0.1.0

Please sign in to comment.