crieur/README.md
koalp c4ab210c4d
feat: add retrieval application and one newspaper
A first example as well as some documentation have been added

The first example builds an article location and download the article as
an html String.

The documentation explains how it has been designed and what is the goal
of the application as well as it's intended architecture
2021-04-23 22:12:02 +02:00

18 lines
496 B
Markdown

Tools to retrieve articles from multiple newspaper you subscribed to.
**This is a prototype, it isn't stable at all and you may not want to use it if you expect it to just work !**
# How to use it
First retrieve login cookies for websites and put it in a `.env`
```
cargo run --example=retrive_html_articles
```
# Documentation
- 1. [Design](documentation/design/index.md)
- a. [Scope of the project](documentation/design/scope.md)
- b. [Retrieve](documentation/design/retrieve.md)