From 00ba1655ca5f42b782976949f406f3f6c6499ac0 Mon Sep 17 00:00:00 2001 From: Asim Aslam Date: Thu, 4 Jul 2019 11:15:54 +0100 Subject: [PATCH] remove some readmes --- api/README.md | 18 ------------------ config/README.md | 2 +- network/proxy/README.md | 25 ------------------------- 3 files changed, 1 insertion(+), 44 deletions(-) delete mode 100644 api/README.md delete mode 100644 network/proxy/README.md diff --git a/api/README.md b/api/README.md deleted file mode 100644 index 371d5ff3..00000000 --- a/api/README.md +++ /dev/null @@ -1,18 +0,0 @@ -# Go API [![License](https://img.shields.io/:license-apache-blue.svg)](https://opensource.org/licenses/Apache-2.0) [![GoDoc](https://godoc.org/github.com/micro/go-micro/api?status.svg)](https://godoc.org/github.com/micro/go-micro/api) [![Travis CI](https://api.travis-ci.org/micro/go-micro/api.svg?branch=master)](https://travis-ci.org/micro/go-micro/api) [![Go Report Card](https://goreportcard.com/badge/micro/go-micro/api)](https://goreportcard.com/report/github.com/micro/go-micro/api) - -Go API is a pluggable API framework driven by service discovery to help build powerful public API gateways. - -## Overview - -The Go API library provides api gateway routing capabilities. A microservice architecture decouples application logic into -separate service. An api gateway provides a single entry point to consolidate these services into a unified api. The -Go API uses routes defined in service discovery metadata to generate routing rules and serve http requests. - -Go API - -Go API is the basis for the [micro api](https://micro.mu/docs/api.html). - -## Getting Started - -See the [docs](https://micro.mu/docs/go-api.html) to learn more - diff --git a/config/README.md b/config/README.md index f1265f51..56e21db9 100644 --- a/config/README.md +++ b/config/README.md @@ -1,6 +1,6 @@ # Config [![GoDoc](https://godoc.org/github.com/micro/go-micro/config?status.svg)](https://godoc.org/github.com/micro/go-micro/config) -Go Config is a pluggable dynamic config library. +Config is a pluggable dynamic config package Most config in applications are statically configured or include complex logic to load from multiple sources. Go Config makes this easy, pluggable and mergeable. You'll never have to deal with config in the same way again. diff --git a/network/proxy/README.md b/network/proxy/README.md deleted file mode 100644 index fdbeaf8c..00000000 --- a/network/proxy/README.md +++ /dev/null @@ -1,25 +0,0 @@ -# Go Proxy [![License](https://img.shields.io/:license-apache-blue.svg)](https://opensource.org/licenses/Apache-2.0) [![GoDoc](https://godoc.org/github.com/micro/go-proxy?status.svg)](https://godoc.org/github.com/micro/go-proxy) - -Go Proxy is a proxy library for Go Micro. - -## Overview - -Go Micro is a distributed systems framework for client/server communication. It handles the details -around discovery, fault tolerance, rpc communication, etc. We may want to leverage this in broader ecosystems -which make use of standard http or we may also want to offload a number of requirements to a single proxy. - -## Features - -- **Transparent Proxy** - Proxy requests to any micro services through a single location. Go Proxy enables -you to write Go Micro proxies which handle and forward requests. This is good for incorporating wrappers. - -- **Single Backend Router** - Enable the single backend router to proxy directly to your local app. The proxy -allows you to set a router which serves your backend service whether its http, grpc, etc. - -- **Protocol Aware Handler** - Set a request handler which speaks your app protocol to make outbound requests. -Your app may not speak the MUCP protocol so it may be easier to translate internally. - -- **Control Planes** - Additionally we support use of control planes to offload many distributed systems concerns. - * [x] [Consul](https://www.consul.io/docs/connect/native.html) - Using Connect-Native to provide secure mTLS. - * [x] [NATS](https://nats.io/) - Fully leveraging NATS as the control plane and data plane. -