diff --git a/docs/intro.rst b/docs/intro.rst index ff20f8432..7506d0196 100644 --- a/docs/intro.rst +++ b/docs/intro.rst @@ -1,6 +1,6 @@ Introduction ============ -CGRates is a very fast and easy scalable rating engine targeted especially for telecom providers. +CGRateS is a very fast and easy scalable rating engine targeted especially for telecom providers. It is written in go (http://golang.net) and accessible from any language via JSON RPC. The code is well documented (go doc compliant API docs) and heavily tested. @@ -19,12 +19,12 @@ Features + Received calls bonus + Fully/Easy configurable + Very fast (5000+ req/sec) -+ Good documentation ++ Good documentation ( that's me :) + Commercial support available -How does CGRates work? +How does CGRateS work? ---------------------- -Let's start with the most important function: finding the cost of a certain call. The call information comes to CGRates as the following values: subject, destination, start time and end time. The engine will lookup in the database for the activation periods applicable to the received subject and destination. What are the activation periods? +Let's start with the most important function: finding the cost of a certain call. The call information comes to CGRateS as the following values: subject, destination, start time and end time. The engine will lookup in the database for the activation periods applicable to the received subject and destination. What are the activation periods? The activation period is a structure describing different prices for a call on different intervals of time. This structure has an activation time, from this time on the activation period is in effect and one ore more (usually more than one) intervals with prices. An interval is looking like this: diff --git a/docs/tutorial.rst b/docs/tutorial.rst index 8032aaabe..6795f791a 100644 --- a/docs/tutorial.rst +++ b/docs/tutorial.rst @@ -1,8 +1,8 @@ Tutorial ======== -The general usage of the CGRates involves creating a CallDescriptor structure sending it to the balancer via JSON RPC and getting a response from the balancer inf form of a CallCost structure or a numeric value for requested information. +The general usage of the CGRateS involves creating a CallDescriptor structure sending it to the balancer via JSON RPC and getting a response from the balancer inf form of a CallCost structure or a numeric value for requested information. -The general steps to get up and running with CGRates are: +The general steps to get up and running with CGRateS are: #. Create JSON files containing rates, budgets, tariff plans and destinations, see :ref:`data-importing`. #. Load the data in the databases using the loader tool. @@ -62,7 +62,7 @@ Instalation Running ------- -There are only three main command to used with CGRates: +There are only three main command to used with CGRateS: balancer The balancer will open a JSON RPC server and an HTTP server ready for taking external requests. It will also open and rater server on witch the raters will register themselves when they start.