From c5603619efdcc9fd8821d2d0f8593931e0e8224e Mon Sep 17 00:00:00 2001
From: Jordan Eldredge <jordan@jordaneldredge.com>
Date: Mon, 18 May 2020 09:05:12 -0700
Subject: [PATCH] Add readmes

---
 .../README.md                                 | 10 ++++++++++
 packages/skin-database/README.md              | 19 +++++++++++++++++++
 packages/skinArchiveTools/README.md           |  2 ++
 packages/tweetBot/README.md                   |  5 +++++
 4 files changed, 36 insertions(+)
 create mode 100644 packages/archive-org-webamp-integration-tests/README.md
 create mode 100644 packages/skin-database/README.md
 create mode 100644 packages/tweetBot/README.md

diff --git a/packages/archive-org-webamp-integration-tests/README.md b/packages/archive-org-webamp-integration-tests/README.md
new file mode 100644
index 00000000..109c823e
--- /dev/null
+++ b/packages/archive-org-webamp-integration-tests/README.md
@@ -0,0 +1,10 @@
+# Archive.org Webamp Integration Test
+
+This package contains an automated test to ensure that the [Webamp](https://webamp.org) integration on https://archive.org is still working correectly. It's run twice a day via a GitHub Action, which can be found [here](../../ia-integration-tests.yml).
+
+## Run
+
+```sh
+yarn
+node index.js
+```
diff --git a/packages/skin-database/README.md b/packages/skin-database/README.md
new file mode 100644
index 00000000..eda64c4f
--- /dev/null
+++ b/packages/skin-database/README.md
@@ -0,0 +1,19 @@
+# Winamp Skin Database
+
+This package contains code for managing the collection of Winamp skins which are used for various projects related to [Webamp](https://webamp.org):
+
+- [@winampSkins](https://twitter.com/winampskins) Twitter Bot
+- The Discord bot used in the Webamp Discord
+
+## Discord Bot
+
+The discord bot allows us to:
+
+- Review skins for use by the Twitter bot
+- Upload new skins to the database
+- Get a screenshot of a given skin
+- Get a link/screenshot of a skin based on its hash
+
+## Server
+
+This package also includes a GraphQL interface for exploring skins. It is not currently used by anything, but can be useful for inspecting the data.
diff --git a/packages/skinArchiveTools/README.md b/packages/skinArchiveTools/README.md
index 25f84b2d..55ea9763 100644
--- a/packages/skinArchiveTools/README.md
+++ b/packages/skinArchiveTools/README.md
@@ -1,5 +1,7 @@
 # Skin Archive Tools
 
+**Note:** My goal is to merge this into the `skin-database` package.
+
 A collection of scripts for managing the Internet Archive's collection of Winamp Skins.
 
 It works as a data pipeline. The phases are:
diff --git a/packages/tweetBot/README.md b/packages/tweetBot/README.md
new file mode 100644
index 00000000..1ec3f459
--- /dev/null
+++ b/packages/tweetBot/README.md
@@ -0,0 +1,5 @@
+# Tweet Bot
+
+This "package" is actually a Python script. Originally the [@winampskins](https://twitter.com/winampskins) Twitter bot was a Python script that ran as a cron job. I've since rewritten most of it in JavaScript. The core part that actually talks to the Twitter API is still written in Python. That last remaining code can be found here.
+
+Hopefully it will soon be rewritten in JavaScript.