From 2d10e83ee6200ea616198e9d587cf7977e717d5e Mon Sep 17 00:00:00 2001
From: Waylon Walker <walker_waylon_s@cat.com>
Date: Fri, 11 Jun 2021 08:29:29 -0500
Subject: [PATCH] Add README

---
 README.md | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..4d962b4
--- /dev/null
+++ b/README.md
@@ -0,0 +1,26 @@
+# pypi-list
+
+Live on [pypi-list.waylonwalker.com](https://pypi-list.waylonwalker.com/)
+
+Listing python packages from pypi, and finding available single word packages.
+
+## Install
+
+``` bash
+pip install -r requirements.txt
+```
+
+## Run the Pipeline
+
+``` bash
+# Run with existing package data
+python pypi-list.py
+
+# Full run
+python pypi-list.py --full
+```
+
+## Scheduled on GitHub actions
+
+This pipeline run daily at `0:0` to generate a `packages.json`,
+`unavailable.json`, `avalilable.json`.