Descriptions (#42)

* adding descriptions

* fix title

* add geocoding

* update location readme

* update places api

* update posts readme

* update routing

* update users
This commit is contained in:
Asim Aslam
2021-01-20 10:02:06 +00:00
committed by GitHub
parent c12028da38
commit 42370d50f3
9 changed files with 27 additions and 17 deletions

View File

@@ -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
}
]
}
```
```

View File

@@ -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

View File

@@ -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

View File

@@ -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.
The geocoding service provides address to lat lng geocoding as well as the reverse. Useful for building mapping or location
based services.

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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
```