Skip to content

Commit

Permalink
improved readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ThiagoNelsi authored Jan 20, 2020
1 parent fe6e389 commit e3d2935
Showing 1 changed file with 22 additions and 4 deletions.
26 changes: 22 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -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).

> # 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.
>

0 comments on commit e3d2935

Please sign in to comment.