From e3d293578674d82c6fdfb95e9b0a2b70c14309c4 Mon Sep 17 00:00:00 2001
From: Thiago Nelsi do Couto <52456089+ThiagoNelsi@users.noreply.github.com>
Date: Mon, 20 Jan 2020 19:24:47 -0300
Subject: [PATCH] improved readme

---
 README.md | 26 ++++++++++++++++++++++----
 1 file changed, 22 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 3a5f74a..7eaf017 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,22 @@
-# Wikipedia-content-fetcher-getter-and-formatter
- This project searches Wikipedia articles from a user-entered term, collects content and formats in .docx and JSON format.
- All the project is made with NodeJS and uses Agorithmia APIs (Wikipedia parser and Summarizer).
- 
\ No newline at end of file
+> # Wikipedia Content Getter
+>  This project collects Wikipedia articles from a search term entered by the user and formats the data in a .docx document with images related to each section of the collected article.
+>
+> ## APIs
+> All the project is made with NodeJS and uses the following APIs:
+> * [Wikipedia Parser API](https://www.algorithmia.com/algorithms/web/WikipediaParser) (from [Algorithmia](https://www.algorithmia.com/))
+> * [Google Custom Search](https://developers.google.com/custom-search) (from [Google Cloud Platform](https://cloud.google.com/))
+> * [Natural Language Understanding](https://cloud.ibm.com/catalog/services/natural-language-understanding) (from [IBM CLOUD](https://cloud.ibm.com))
+>
+> ## Main dependencies
+> * [algorithmia](https://algorithmia.com/developers/clients/node)
+> * [docx](https://www.npmjs.com/package/docx)
+> * [googleapis](https://developers.google.com/drive/api/v3/quickstart/nodejs)
+> * [ibm-watson](https://www.npmjs.com/package/ibm-watson)
+> * [image-downloader](https://www.npmjs.com/package/image-downloader)
+> * [readline-sync](https://www.npmjs.com/package/readline-sync)
+> * [watson-developer-cloud](https://www.npmjs.com/package/watson-developer-cloud)
+>
+> You can use this app by running the index.js file and typing a search term, after this you just need to select a language and wait for the app end the process.
+>
+> At the end of the process a folder will be created at the root of the project with the same name as the search term containing the .docx document and a folder with the images.
+>