From 9884959464a1dfa907b55dac3ab21cee21dcbd09 Mon Sep 17 00:00:00 2001
From: Ben Cotton <bcotton@fedoraproject.org>
Date: Jul 09 2018 18:16:15 +0000
Subject: Add a README


---

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f686126
--- /dev/null
+++ b/README.md
@@ -0,0 +1,18 @@
+This repo creates scripts for managing the [Fedora Changes process][https://fedoraproject.org/wiki/Fedora_Program_Management/ChangesSOP].
+
+## createbz.py
+Creates Bugzilla tickets in the Fedora Changes component from a CSV file.
+
+**Usage:**  ``createbz.py <CSV file>``
+
+The CSV file contains the following fields:
+* **Name** — A descriptive name of the change, used as the Bugzilla ticket *summary*
+* **Email** — Comma-separated email addresses(es) of change owner(s), used as the Bugzilla ticket *cc*
+* **Summary** — A brief summary of the change, used as the Bugzilla ticket *description*
+* **Bug** — A column for recording the bug. The column must exist. A new bug will only be created if the field is empty for a given row.
+
+Login credentials come from the ${HOME}/.bugzillarc file. e.g.
+```   [core]
+   user = myname@example.com
+   password = hunter2
+```