README.md in xcflushd-1.0.0.rc2 vs README.md in xcflushd-1.0.0

- old
+ new

@@ -3,11 +3,11 @@ [![Build Status](https://travis-ci.org/3scale/xcflushd.svg?branch=master)](https://travis-ci.org/3scale/xcflushd) [![Code Climate](https://codeclimate.com/repos/585a6e7cd78de855e5002463/badges/7825d2a1491b30a172f7/gpa.svg)](https://codeclimate.com/repos/585a6e7cd78de855e5002463/feed) ## Description This is the daemon that flushes the data that the gateway side of XC like the -[apicast-xc](https://github.com/3scale/apicast-xc) module running on top of [Apicast](https://github.com/3scale/apicast), stores for reporting and authorizing to 3scale. +[apicast-xc](https://github.com/3scale/apicast-xc) module running on top of [APIcast](https://github.com/3scale/apicast), stores for reporting and authorizing to 3scale. When you deploy 3scale to a gateway you usually have a request performed to 3scale for every request that needs authorization, which introduces latency and load in 3scale. The goal of XC is to reduce latency and increase throughput by significantly reducing the number of requests made to 3scale's backend. In @@ -66,11 +66,11 @@ $ docker run --rm xcflushd bundle exec xcflushd help run ``` You can send the options as params in the `xcflushd` command: ``` -$ docker run --rm xcflushd bundle exec xcflushd run --auth-ttl 900 --provider-key my_provider_key --redis 127.0.0.1:6379 --frequency 300 --backend https://su1.3scale.net:443 +$ docker run --rm -it xcflushd bundle exec xcflushd run --auth-ttl 900 --provider-key my_provider_key --redis 127.0.0.1:6379 --frequency 300 --backend https://su1.3scale.net:443 ``` Please note that the help command will also show you abbreviated flags you can use at your convenience. @@ -86,10 +86,10 @@ $ bundle exec xcflushd help ``` ### Openshift -If what you need is deploying Xcflushd together with Apicast and XC, you can +If what you need is deploying Xcflushd together with APIcast and XC, you can follow the instructions provided in the [apicast-xc repo](https://github.com/3scale/apicast-xc). ## How it works