Initial commit

1 files changed, 31 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..af9f385
--- /dev/null
+++ b/README.md
@@ -0,0 +1,31 @@
+# Registro Civil Scraper
+
+A small scraper I did with Selenium for the civil registry in Uruguay, a Telegram bot that sends me a message when there are new appointments.
+
+## What do you need?
+
+- A Telegram APP (talk to @BotFather for that).
+- A way to run cronjobs.
+
+## How to use it?
+
+- Create a local copy of the `.env.example` file with your own credentials.
+
+``` sh
+cp .env.example .env
+```
+
+- Install your dependencies.
+
+``` sh
+pip -r requirements.txt
+```
+
+- Run it!
+
+``` sh
+./app.py
+```
+
+# License
+The files and scripts in this repository are licensed under the MIT License, which is a very permissive license allowing you to use, modify, copy, distribute, sell, give away, etc. the software.  In other words, do what you want with it.  The  only requirement with the MIT License is that the license and copyright notice must be provided with the software.