Improve the readme

This commit is contained in:
Mike Coutermarsh
2019-08-27 15:35:20 -07:00
committed by GitHub
parent 4634ff4555
commit d9d8ca84f7
+15 -5
View File
@@ -1,14 +1,24 @@
These are templates for onboarding new users into GitHub Actions. There are a few directories:
<p align="center">
<img src="https://avatars0.githubusercontent.com/u/44036562?s=100&v=4"/>
</p>
## Starter Workflows
<img src="https://d3vv6lp55qjaqc.cloudfront.net/items/353A3p3Y2x3c2t2N0c01/Image%202019-08-27%20at%203.25.07%20PM.png" max-width="75%"/>
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