diff --git a/README.md b/README.md index 2c2f1b5..4b5b9f8 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ These are the workflow files for helping people get started with GitHub Actions. ### Directory structure -* [ci](ci): solutions for Continuous Integration +* [ci](ci): solutions for Continuous Integration and Deployments * [automation](automation): solutions for automating workflows. * [code-scanning](code-scanning): starter workflows for [Code Scanning](https://github.com/features/security) * [icons](icons): svg icons for the relevant template @@ -23,10 +23,22 @@ For example: `ci/django.yml` and `ci/properties/django.properties.json`. ### Valid properties -* `name`: the name shown in onboarding +* `name`: the name shown in onboarding. This property is unique within the repository. * `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 -* `categories`: the categories that it will be shown under +* `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. Another option is to use [octicon](https://primer.style/octicons/). The format to use an octicon is `octicon <>`. Example: `octicon person` +* `creator`: creator of the template shown in onboarding. All the workflow templates from an author will have the same `creator` field. +* `categories`: the categories that it will be shown under. Choose at least one category from the list [here](#categories). Further, choose the categories from the list of languages available [here](https://github.com/github/linguist/blob/master/lib/linguist/languages.yml). When a user views the available templates, those templates that match the same language will feature more prominently. + +### Categories +* continuous-integration +* deployment +* testing +* code-quality +* code-review +* dependency-management +* monitoring +* Automation +* utilities ### Variables These variables can be placed in the starter workflow and will be substituted as detailed below: