Update README.md

Standardisation of the document

Author: khanzadyan

README.md

@@ -1,94 +1,79 @@
-# csv-component
+# CSV Component
 
-A CSV component for the [elastic.io platform](http://www.elastic.io "elastic.io platform").
+## Description
 
+A component to read and write Comma Separated Values (CSV) files.
 
-## Write CSV attachment
+## How works
 
-Multiple incoming events can be combined into one CSV file with the write CSV
-action.  Incoming events will be written into the CSV file until there is a gap
-of more than 10 seconds between events.  As part of the component setup, one
-must specify the columns of the CSV file.  These columns will be published as
-the header in the first row.  For each incoming event, the value for each header
-will be stringified and written as the value for that cell.  All other
-properties will be ignored.  For example, headers ``foo,bar`` along with the
-following JSON events
+The component can read the CSV file from a remote URL or from the message
+attachment. It can also write a CSV file from the incoming events.
 
-    {"foo":"myfoo", "bar":"mybar"}
-    {"foo":"myfoo", "bar":[1,2]}
-    {"bar":"mybar", "baz":"mybaz"}
+## Requirements
 
-will produce the following ``.csv`` file:
+## Environment variables
 
-    foo,bar
-    myfoo,mybar
-    myfoo,"[1,2]"
-    ,mybar
+Component is not using any environment variables.
 
-When columns are added in the UI, you will be presented with an opportunity to
-provide a JSONata expression per column.  If you require number formatting that
-is specific to a locale, the JSONata expression should handle that concern.
 
-![screenshot from 2017-10-17 09-28-04](https://user-images.githubusercontent.com/5710732/31651871-926b4530-b31d-11e7-936f-bcf3ff05f8e2.png)
+## Credentials
 
-The output of the CSV Write component will be a message with an attachment.  In
-order to access this attachment, the component following the CSV Write must be
-able to handle file attachments such as the [SFTP
-component](https://github.com/elasticio/sftp-component).
+The component does not require credentials to function.
 
-This is an open source component to work with
-[CSV](http://en.wikipedia.org/wiki/Comma-separated_values) files in your
-integration flow and is developed specifically to run on [elastic.io
-platform](http://www.elastic.io "elastic.io platform"). You can clone it and
-change it as you wish. However, **if you plan to deploy it into [elastic.io
-platform](http://www.elastic.io "elastic.io platform") you must follow sets of
-instructions to succeed**.
 
-> **PLEASE NOTE:** This is a working component for **CSV** files, however, it
-may not be suitable for every use case. Not all functionality is included in
-this component template. **It is your responsibility to add and modify this
-component to suit your integration needs.**
+## Triggers
 
-## Before you Begin
+### Read CSV file from URL
 
-Before you can deploy any code into our system **you must be a registered
-elastic.io platform user**. Please see our home page at
-[http://www.elastic.io](http://www.elastic.io) to learn how.
+This trigger will fetch the CSV file from a given URL. The address must be accessible
+to the component. The fetched CSV file will be placed in the attachment part of the
+outgoing message.
 
-> Any attempt to deploy a code into our platform without a registration would fail.
+## Actions
 
-After the registration and opening of the account you must **[upload your SSH
-Key](http://docs.elastic.io/docs/ssh-key)** into our platform.
+### Read CSV attachment
 
-> If you fail to upload you SSH Key you will get **permission denied** error
-during the deployment.
+This action will read the CSV attachment of the incoming message and output
+a `JSON` object. To configure this action the following fields can be used:
 
-## Getting Started
+*   `CSV Header` - this is a required field. Input the names of headers separated with a comma.
+*   `Separators` - Specify the separator type. Usually it is a comma (`,`) but values like Semicolon (`;`), Space (` `), Tab (`\t`) and Hash (`#`) are also supported.
+*   `Skip rows` - if you know that the incoming CSV file has certain number of headers you can indicate to skip them. The supported values are `None`, `First row`, `First two`, `Dirst three` and `First four`.
+*   `Data columns` - here the values will be added dynamically based on the values in the `CSV Header` field. Here each data column will be listed with the name, Data Type and the Format to enable further configuration.
 
-After registration and uploading of your SSH Key you can proceed to deploy it
-into our system. At this stage we suggest you to:
-* [Create a team](http://docs.elastic.io/page/team-management) to work on your
- new component. This is not required but will be automatically created using
- random naming by our system so we suggest you name your team accordingly.
-* [Create a repository](http://docs.elastic.io/page/repository-management) where
-* your new component is going to *reside* inside the team that you have just
-* created. For a simplicity you can name your repository **csv-component** or
-* **csv**.
 
-```bash
-$ git clone https://github.com/elasticio/csv-component.git csv-component
+### Write CSV attachment
 
-$ cd csv-component
-```
-Now you can edit your version of **csv-component** component and change
-according to your needs - that is if you know what you are doing. Or you can
-just ``PUSH``it into our system to see the process in action:
+This action will combine multiple incoming events into a CSV file until there is a gap
+of more than 10 seconds between events. Afterwards, the CSV file will be closed
+and attached to the outgoing message.
+
+As part of the component setup, one must specify the columns of the CSV file.
+These columns will be published as the header in the first row. For each incoming
+event, the value for each header will be `stringified` and written as the value
+for that cell. All other properties will be ignored. For example, headers
+`foo,bar` along with the following JSON events:
 
-```bash
-$ git remote add elasticio [email protected]:csv-component.git
+```
+{"foo":"myfoo", "bar":"mybar"}
+{"foo":"myfoo", "bar":[1,2]}
+{"bar":"mybar", "baz":"mybaz"}
+```
 
-$ git push elasticio master
+will produce the following `.csv` file:
 ```
-Obviously the naming of your team and repository is entirely up-to you and if
-you do not put any corresponding naming our system will auto generate it for you
-but the naming might not entirely correspond to your project requirements.
+foo,bar
+myfoo,mybar
+myfoo,"[1,2]"
+,mybar
+```
+
+When columns are added in the UI, you will be presented with an opportunity to
+provide a JSONata expression per column. If you require number formatting that
+is specific to a locale, the JSONata expression should handle that concern.
+
+![screenshot from 2017-10-17 09-28-04](https://user-images.githubusercontent.com/5710732/31651871-926b4530-b31d-11e7-936f-bcf3ff05f8e2.png)
+
+The output of the CSV Write component will be a message with an attachment.  In
+order to access this attachment, the component following the CSV Write must be
+able to handle file attachments.