diff --git a/README.md b/README.md index 7e39b84..0e8332e 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,33 @@ -IP to geolocation lookup +# Micro Services -## IP Service +The canonical source for Micro services. -The IP or ip2geo service provides IP to geolocation lookup. It includes asn, city, country and lat/long. +## Overview +Services provides a home for real world reusable Micro services. + +- [routing](routing) - etas, routes and turn by turn directions +- [geocoding](geocoding) - address to gps location and reverse +- [location](location) - gps point location tracking + +## Usage + +Run a service from source + +``` +micro run github.com/micro/services/helloworld +``` + +## Contributing + +Feel free to contribute by PR and signoff. + +## Documentation + +Documentation for this repo is autogenerated and appears on [services.m3o.com](https://services.m3o.com) + +Read this [doc](cmd/docgen/README.md) on how to write documentation for these services. + +## License + +[Polyform Strict](https://polyformproject.org/licenses/strict/1.0.0/)