From 42370d50f3b346c40673742ca0a7aa3ff76f3401 Mon Sep 17 00:00:00 2001 From: Asim Aslam Date: Wed, 20 Jan 2021 10:02:06 +0000 Subject: [PATCH] Descriptions (#42) * adding descriptions * fix title * add geocoding * update location readme * update places api * update posts readme * update routing * update users --- chat/README.md | 6 +++--- etas/README.md | 4 +++- feeds/README.md | 6 ++++-- geocoding/README.md | 5 +++-- location/README.md | 5 ++++- places/README.md | 7 ++----- posts/README.md | 4 +++- routing/README.md | 4 ++-- users/README.md | 3 +++ 9 files changed, 27 insertions(+), 17 deletions(-) diff --git a/chat/README.md b/chat/README.md index ab67e6c..b9c8e05 100644 --- a/chat/README.md +++ b/chat/README.md @@ -1,8 +1,8 @@ -The chat service is an example Micro service which leverages bidirectional streaming, the store and events to build a chat backend. There is both a server and client which can be run together to demonstrate the application (see client/main.go for more instructions on running the service). +Real time messaging API which enables Chat services to be embedded anywhere # Chat Service -The service is documented inline and is designed to act as a reference for the events package. +The Chat service is a programmable instant messaging API service which can be used in any application to immediately create conversations. ## Create a chat @@ -84,4 +84,4 @@ The service is documented inline and is designed to act as a reference for the e } ] } -``` \ No newline at end of file +``` diff --git a/etas/README.md b/etas/README.md index 1e2b181..bc55803 100644 --- a/etas/README.md +++ b/etas/README.md @@ -1,7 +1,9 @@ -This is the ETAs service. It provides ETAs for single-pickup, multi-dropoff routes. It takes into account time and traffic. +ETAs as a service. Provides single-pickup and multi-dropoff routes. Takes into account time and traffic. # ETAs Service +Add accurate estimated time of arrival to apps for delivery tracking, routing directions and much more. + Current limitations: • Only supports "Driving" (not walking, cycling) • Does not optimize route diff --git a/feeds/README.md b/feeds/README.md index 53955ea..717da5f 100644 --- a/feeds/README.md +++ b/feeds/README.md @@ -1,8 +1,10 @@ -Designed to populate the posts service with RSS feeds from other blogs. Useful for migration or just to get outside content into the posts service. +A single uniform API for crawling and indexing RSS feeds # Feeds Service -## Creating a feeed +Designed to populate the posts service with RSS feeds from other blogs. Useful for migration or just to get outside content into the posts service. + +## Creating a feed ### cURL diff --git a/geocoding/README.md b/geocoding/README.md index 7abde71..b6ef7ec 100644 --- a/geocoding/README.md +++ b/geocoding/README.md @@ -1,5 +1,6 @@ -The geocoding service provides address to lat lng geocoding as well as the reverse. +Geocode an address to gps coordinates and the reverse. # Geocoding service -Examples coming soon. Check the [proto](https://github.com/micro/services/blob/master/geocoding/proto/geocoding.proto) for more details. \ No newline at end of file +The geocoding service provides address to lat lng geocoding as well as the reverse. Useful for building mapping or location +based services. diff --git a/location/README.md b/location/README.md index 9e10228..f897182 100644 --- a/location/README.md +++ b/location/README.md @@ -1,6 +1,9 @@ +Real time GPS location tracking and search + # Location Service -A realtime GPS location tracking and search service +Send, store and search real time gps point data and tracking info using the location API. +Build powerful map rendered views with up to the second updated points on the map. Generated with diff --git a/places/README.md b/places/README.md index 8b5541f..ac4703b 100644 --- a/places/README.md +++ b/places/README.md @@ -1,12 +1,9 @@ -The places service stores places of interest by geolocation. +Store and search for points of interest # Places Service -Generated with +The places API stores points of interest and enables you to search for places nearby or last visited. -``` -micro new places -``` ## Usage diff --git a/posts/README.md b/posts/README.md index 7aabf57..256cca4 100644 --- a/posts/README.md +++ b/posts/README.md @@ -1,7 +1,9 @@ -The post service is responsible for storing and querying posts by their slugs or IDs. Posts support tags and metadata, for details see `posts.proto`. +Build a blog or the foundations of a headless CMS with posts # Post Service +Posts is the foundation of a headless CMS, storing blog posts with their metadata and enabling simple retrieval and querying. + ## Create a post ### cURL diff --git a/routing/README.md b/routing/README.md index 91d46b1..ad44ff3 100644 --- a/routing/README.md +++ b/routing/README.md @@ -1,5 +1,5 @@ -The routing service provides point to point directions. +Point to point routing directions # Routing Service -Readme coming soon. For more info see the [proto](https://github.com/micro/services/blob/master/routing/proto/routing.proto). +The routing service provides point to point directions diff --git a/users/README.md b/users/README.md index 089881f..b3f91cc 100644 --- a/users/README.md +++ b/users/README.md @@ -2,6 +2,9 @@ A user service for storing accounts and simple auth. # Users Service +The users service provides user management and authentication so you can easily add them to your own apps +without having to build the entire thing from scratch. + ## Getting started ```