Merge pull request #5 from Enigmatis/add-readme

Add readme

README.md

@@ -1,2 +1,35 @@
-# graphql-logger
-A library that organizes graphql logs
+![Small Logo](static/img/polaris-logo.png)
+
+# polaris-graphql-logger
+
+[![Build Status](https://travis-ci.com/Enigmatis/polaris-graphql-logger.svg?branch=master)](https://travis-ci.com/Enigmatis/polaris-graphql-logger)
+[![NPM version](https://img.shields.io/npm/v/@enigmatis/polaris-graphql-logger.svg?style=flat-square)](https://www.npmjs.com/package/@enigmatis/polaris-graphql-logger)
+
+#### Install
+
+```
+npm install polaris-graphql-logger
+```
+
+### Overview
+
+Polaris GraphQL Logger allows you to write standardized logs easily, using a polaris-logs logger, and wrapping a classic
+graphql logger.
+
+#### GraphQLLogProperties
+
+This interface defines the graphql log properties that can be logged whenever the logger is called.
+This interface extends the `PolarisLogProperties` that `polaris-logs` library offers.
+The property that `GraphQLLogProperties` adds in addition is:
+
+-   operationName(_string - Optional_): the name of the requested graphql operation.
+
+#### GraphQLLogger
+
+This interface defines all of the logging level options that available in the graphql logger.
+It provides the usual methods of logger, such as `warn`, `error`, `fatal`, `info`, `trace` and `debug`.
+
+#### PolarisGraphQLLogger
+
+This class gives you the ability to send PolarisGraphQLContext and PolarisLogProperties and have it build a log according
+to the standard way.