Commit inicial.

[planetlibre.git/.git] / README.md

diff --git a/README.md b/README.md
index 4a55e72..8df96d7 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,2 +1,24 @@
 # planetlibre
-Simple RSS reader like a planet side
+Simple RSS reader like a planet side.
+
+# Lector simple de RSS
+
+Este es un sencillo lector de RSS basado en python3. La lectura de las entradas se realiza de forma similar a un planet. Por defecto viene configurado con una serie de feeds para blogs que tratan sobre software libre.
+
+# Instalación
+
+Sólo hay que descargarlo e instalar el siguiente paquete:
+
+    sudo apt-get install feedparser
+
+Después se ejecuta con:
+
+    python3 planet.py
+
+# Salida generada
+
+Una vez ejecutado el comando "python3 planet.py", se generará en la carpeta "salida" una serie de archivos html con las entradas leídas desde los blogs.
+
+# Modificación / introducción de nuevos blogs
+
+Hay que modificar el archivo "blogs_feeds.txt" con los feeds de los blogs que se deseen añadir. Se debe colocar uno por línea.
\ No newline at end of file