From 1d9b97aa59206153e41c8b4b4c39c14c92dd49f4 Mon Sep 17 00:00:00 2001
From: Davide Violante <DavideViolante@users.noreply.github.com>
Date: Tue, 26 May 2020 11:10:31 +0200
Subject: [PATCH] Update README.md

---
 README.md | 30 ++++++++++++++++++++++++++++--
 1 file changed, 28 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 68ebeb7..3e44b27 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,28 @@
-# investing-com-api
-Unofficial APIs for Investing.com website.
+# Investing.com unofficial APIs ![Node.js CI](https://github.com/DavideViolante/investing-com-api/workflows/Node.js%20CI/badge.svg) [![Donate](https://img.shields.io/badge/paypal-donate-179BD7.svg)](https://www.paypal.me/dviolante)
+
+Unofficial APIs wrapper for Investing.com website.
+
+### Install
+`npm i investing-com-api`
+
+### Example
+```js
+const investing = require('investing-com-api')
+const response = investing('<pairId>') // pairId identifies the data to get, see below
+// response = [ { date: Timestamp, value: Number }, {...}, ... ]
+```
+
+### How to find pairId
+1. Go to investing.com page where there is the chart of your interest
+2. View the page source and find `pairId:`
+3. Use the pairId as a String to call the APIs
+
+
+### Run tests
+- `npm test`
+
+### Run lint
+- `npm run lint`
+
+### Author
+- [Davide Violante](https://github.com/DavideViolante/)