Update README.md

This commit is contained in:
Tom Pallister 2018-03-02 17:58:22 +00:00 committed by GitHub
parent 2d3d2abf06
commit b7db8773b6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -27,11 +27,28 @@ Ocelot manipulates the HttpRequest object into a state specified by its configur
it reaches a request builder middleware where it creates a HttpRequestMessage object which is it reaches a request builder middleware where it creates a HttpRequestMessage object which is
used to make a request to a downstream service. The middleware that makes the request is used to make a request to a downstream service. The middleware that makes the request is
the last thing in the Ocelot pipeline. It does not call the next middleware. the last thing in the Ocelot pipeline. It does not call the next middleware.
The response from the downstream service is stored in a per request scoped repository The response from the downstream service is retrieved as the requests goes back up the Ocelot pipeline.
and retrieved as the requests goes back up the Ocelot pipeline. There is a piece of middleware There is a piece of middleware that maps the HttpResponseMessage onto the HttpResponse object and that
that maps the HttpResponseMessage onto the HttpResponse object and that is returned to the client. is returned to the client. That is basically it with a bunch of other features!
That is basically it with a bunch of other features.
## Features
A quick list of Ocelot's capabilities for more information see the [documentation](http://ocelot.readthedocs.io/en/latest/).
* Routing
* Request Aggregation
* Service Discovery with Consul
* Authentication
* Authorisation
* Rate Limiting
* Caching
* Retry policies / QoS
* Load Balancing
* Logging / Tracing / Correlation
* Headers / Query String / Claims Transformation
* Custom Middleware / Delegating Handlers
* Configuration / Administration REST API
## How to install ## How to install
Ocelot is designed to work with ASP.NET core only and is currently Ocelot is designed to work with ASP.NET core only and is currently
@ -49,20 +66,22 @@ Please click [here](http://ocelot.readthedocs.io/en/latest/) for the Ocleot docu
## Coming up ## Coming up
You can see what we are working on [here](https://github.com/TomPallister/Ocelot/projects/1) You can see what we are working on [here](https://github.com/ThreeMammals/Ocelot/issues).
## Contributing ## Contributing
Pull requests, issues and commentary welcome! No special process just create a request and get in We love to receive contributions from the community so please keep them coming :)
touch either via gitter or create an issue.
Pull requests, issues and commentary welcome!
Please complete the relavent template for issues and PRs. Sometimes it's worth getting in touch with us to discuss changes
before doing any work incase this is something we are already doing or it might not make sense. We can also give
advice on the easiest way to do things :)
Finally we mark all existing issues as help wanted, small, medium and large effort. If you want to contriute for the first time I suggest looking at a help wanted & small effort issue :)
## Things that are currently annoying me ## Things that are currently annoying me
+ The base OcelotMiddleware lets you access things that are going to be null
and doesnt check the response is OK. I think the fact you can even call stuff
that isnt available is annoying. Let alone it be null.
[![](https://codescene.io/projects/697/status.svg) Get more details at **codescene.io**.](https://codescene.io/projects/697/jobs/latest-successful/results) [![](https://codescene.io/projects/697/status.svg) Get more details at **codescene.io**.](https://codescene.io/projects/697/jobs/latest-successful/results)