diff --git a/README.md b/README.md index 3e25a6d..b1dd935 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,24 @@ -These are templates for onboarding new users into GitHub Actions. There are a few directories: +
+
+
+
+These are the workflow files for helping people get started with GitHub Actions.
+
+**Directory structure:**
* [ci](ci): solutions for Continuous Integration
-* [automation](automation): templates for automating workflow.
+* [automation](automation): solutions for automating workflows.
* [icons](icons): svg icons for the relevant template
-Each template must be written in YAML and have a `.yml` extension. Each template needs a corresponding `.properties.json` file that contains extra metadata about the template.
+Each workflow must be written in YAML and have a `.yml` extension. They also need a corresponding `.properties.json` file that contains extra metadata about the workflow (this is displayed in the GitHub.com UI).
For example: `ci/python-django.yml` and `ci/python-django.properties.json`.
-Valid properties:
+**Valid properties:**
* `name`: the name shown in onboarding
* `description`: the description shown in onboarding
-* `iconName`: the icon name in the relevant folder, for example `django` should have an icon `icons/django.svg`. Only SVG is supported at this time.
+* `iconName`: the icon name in the relevant folder, for example `django` should have an icon `icons/django.svg`. Only SVG is supported at this time
* `categories`: the categories that it will be shown under