From 0889e0baccd93b23b21149d8c1ff34a09ca7d208 Mon Sep 17 00:00:00 2001
From: Pierre-Yves Chibon <pingou@pingoured.fr>
Date: Tue, 28 Jan 2020 11:32:05 +0100
Subject: [PATCH] Add basic instructions in the README

Signed-off-by: Pierre-Yves Chibon <pingou@pingoured.fr>
---
 README.rst | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

diff --git a/README.rst b/README.rst
index e69de29..14d0b90 100644
--- a/README.rst
+++ b/README.rst
@@ -0,0 +1,19 @@
+generate changelog
+==================
+
+This project hosts a simple python script that tries to generate a RPM changelog
+from a git repository.
+
+This is how you can use it:
+
+* Clone a dist-git repository
+
+::
+
+  fedpkg clone -a guake
+
+* Run ``generate_changelog`` and point it to the repository cloned above
+
+::
+
+  python generate_change guake