From 01f5707b85de0d5cd1c8db76fd6e1a8cbb13e4b8 Mon Sep 17 00:00:00 2001
From: Darren Ethier <darren@roughsmootheng.in>
Date: Sun, 3 May 2020 09:34:26 -0400
Subject: [PATCH] add initial README.md, CHANGELOG, and .gitignore.

---
 .gitignore   | 52 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 CHANGELOG.md |  0
 README.md    | 41 +++++++++++++++++++++++++++++++++++++++--
 3 files changed, 91 insertions(+), 2 deletions(-)
 create mode 100644 .gitignore
 create mode 100644 CHANGELOG.md

diff --git a/.gitignore b/.gitignore
new file mode 100644
index 00000000..2897e813
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,52 @@
+# Editors
+project.xml
+project.properties
+/nbproject/private/
+.buildpath
+.project
+.settings*
+.idea
+.vscode
+*.sublime-project
+*.sublime-workspace
+.sublimelinterrc
+
+# Grunt
+/node_modules/
+none
+
+# Sass
+.sass-cache/
+
+# OS X metadata
+.DS_Store
+
+# Windows junk
+Thumbs.db
+
+# ApiGen
+/wc-apidocs/
+
+# Behat/CLI Tests
+tests/cli/installer
+tests/cli/composer.phar
+tests/cli/composer.lock
+tests/cli/composer.json
+tests/cli/vendor
+
+# Unit tests
+/tmp
+/tests/bin/tmp
+/tests/e2e-tests/config/local-*.json
+
+# Logs
+/logs
+
+# Composer
+/vendor/
+
+# Built files
+/build/
+bin/languages
+storybook-static/
+/wp-content/
diff --git a/CHANGELOG.md b/CHANGELOG.md
new file mode 100644
index 00000000..e69de29b
diff --git a/README.md b/README.md
index e92bbb02..c4a791bc 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,39 @@
-# automations
-Various github action automations
+# Project management automation
+
+> **Note:** Currently this is experimental while I learn Github actions.
+
+This is a [GitHub Action](https://help.github.com/en/categories/automating-your-workflow-with-github-actions) which contains various automations to assist with project management in a Github repository:
+
+- `todos`: Parses for `@todo` or `@TODO` comments in code and adds as inline review comments for reviews on pull request, and creates issues for each one if they exist when a pull is merged.
+
+# Installation and usage
+
+To use the action, include it in your workflow configuration file:
+
+```yaml
+on: pull_request
+jobs:
+  pull-request-automation:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: WordPress/gutenberg/packages/project-management-automation@master
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          automations: [ todos ]
+
+```
+
+# API
+
+## Inputs
+
+- `github_token`: Required. GitHub API token to use for making API requests. This should be stored as a secret in the GitHub repository.
+- `automations`: Optional. You can include a list of specific automations you want to run if you don't want to use them all in a given workflow.
+
+## Outputs
+
+_None._
+
+## Credits
+
+Thanks to the work of the Gutenberg team (particularly @aduth) in providing some inspiration for this approach to bundling various automations together.