initial commit

1 files changed, 27 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..8cc1d0f
--- /dev/null
+++ b/README
@@ -0,0 +1,27 @@
+Greypool - a repology.org maintainer status tool
+
+Greypool uses the repology.org JSON API to check for outdated
+packages in repositories checked by repology.org. It works with any
+repository, though it's mainly been tested with the "slackbuilds"
+(SlackBuilds.org) repo.
+
+It's written in Perl, and designed to use as few external Perl modules
+as possible. Currently it requires:
+
+- Either JSON::PP or (preferred) JSON::XS
+- POSIX
+- Getopt::Long
+
+Also, wget is required.
+
+On first run, you'll be prompted for an email address and a repository.
+This is saved in the config file.
+
+Output is a report either as plain text (with or without ANSI color),
+comma-separated values (CSV), or HTML.
+
+Greypool complies with repology.org's API guidelines. To avoid excessive
+requests, the API responses are cached for 24 hours.
+
+Greypool was written by B. Watson <urchlay@slackware.uk>, and is
+released under the WTFPL.