Skip to content

Commit

Permalink
Update go version, readme updates
Browse files Browse the repository at this point in the history
  • Loading branch information
robertkleffner committed Dec 28, 2023
1 parent 996e333 commit b4fd71f
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 3 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/go.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ jobs:
- name: Set up Go
uses: actions/setup-go@v4
with:
go-version: '1.21.5'
go-version: '1.19'

- name: Build
run: go build -v ./...
Expand Down
25 changes: 24 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,25 @@
# flatsphere
A library for converting between spherical and planar coordinates.

[![GoReportCard](https://goreportcard.com/badge/owlpinetech/flatsphere)](https://goreportcard.com/report/github.com/owlpinetech/flatsphere)

A [Go][] library for converting between spherical and planar coordinates.

## Prerequisites

- **[Go][]**: any one of the **three latest major** [releases][go-releases].

## Install

go get github.com/owlpinetech/flatsphere

## Usage

// converting from one projection to another
origProj := flatsphere.NewMercator()
newProj := flatsphere.NewLambert()
lat, lon := origProj.Inverse(origX, origY)
newX, newY := newProj.Project(lat, lon)

## Credits

Inspired by the [Map-Projections](https://github.com/jkunimune/Map-Projections) library made by [@jkunimune](https://github.com/jkunimune). Right now this library is essentially a Go-flavored port of his original Java, minus a few things to keep it focused on library use cases.
2 changes: 1 addition & 1 deletion go.mod
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
module github.com/owlpinetech/flatsphere

go 1.21.5
go 1.19

0 comments on commit b4fd71f

Please sign in to comment.