From 9ca98f761449c70653a13d98c9dfa989f67c7440 Mon Sep 17 00:00:00 2001 From: Webber Date: Mon, 30 Mar 2020 23:26:05 +0200 Subject: [PATCH] =?UTF-8?q?Improve=20readme=20readability=20=F0=9F=91=93?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 22 +++++++++++++++++++--- 1 file changed, 19 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index b0d67e4..22336ae 100644 --- a/README.md +++ b/README.md @@ -63,14 +63,14 @@ can be used to test and build projects. ## Setup -##### Mental model +#### Mental model There are two parts to setting up Unity Actions; - Configuring a license - Setting up a workflow -##### First time using GitHub Actions? +#### First time using GitHub Actions? Read the official documentation on how to setup a [workflow](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/configuring-a-workflow). @@ -131,7 +131,7 @@ Detailed instructions for each step can be found in the corresponding actions. ## Simple example -Below is a simple example. +Below is a simple example. It is __recommended__ to start from here. This example assumes that your Unity project is in the root of your repository. @@ -251,6 +251,22 @@ jobs: path: build ``` +Have any questions or comments? Feel free to create an issue! + +## Contributions + +To contribute please follow the contribution +[guide](./CONTRIBUTING.md) +to get set up quickly. + +This repository, and all related actions are open for your suggested changes! + +Feel free to submit a pull request with the suggested changes. + ## Licence +This repository is licensed under the [MIT](./LICENSE) +license. + +This also includes contributions from the community.