From d2beb80109caee88c04d2f011ffd3b2a06a99be1 Mon Sep 17 00:00:00 2001 From: Paul Cager Date: Mon, 7 Dec 2020 21:54:05 +0000 Subject: [PATCH] Create README.md --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..5fc75fe --- /dev/null +++ b/README.md @@ -0,0 +1,21 @@ +# osgrid-server - _Ordnance Survey Grid Ref Converter_ + +This project implements a simple REST server to expose the excellent https://www.movable-type.co.uk/scripts/latlong-os-gridref.html +Ordnance Survey grid reference conversion utilities. + +## Usage + +The easiest way to avoid environmental or Node versioning problems is to start the server using Docker: + + docker run -d --rm --name osgrid-server -p 9090:9090 paulcager/osgrid-server + +A grid reference may then be converted to a lat /lon: + + $ curl http://localhost:9090/gridref/SU3724515505 + 50.93779289256305,-1.471309033422234 + +Or a lat/lon converted to a grid reference: + + $ curl http://localhost:9090/latlon/50.9378,-1.4713 + SU 37245 15505 +