Skip to content

Commit

Permalink
chore: Spruce up readme (#578)
Browse files Browse the repository at this point in the history
  • Loading branch information
kichik authored May 22, 2024
1 parent 8b824d9 commit b0a0eb6
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@

Use this CDK construct to create ephemeral [self-hosted GitHub runners][1] on-demand inside your AWS account.

* Easy to configure GitHub integration with a web-based interface
* Customizable runners with decent defaults
* Multiple runner configurations controlled by labels
* Everything fully hosted in your account
* Automatically updated build environment with latest runner version
* 🧩 Easy to configure GitHub integration with a web-based interface
* 🧠 Customizable runners with decent defaults
* 🏃🏻 Multiple runner configurations controlled by labels
* 🔐 Everything fully hosted in your account
* 🔃 Automatically updated build environment with latest runner version

Self-hosted runners in AWS are useful when:

Expand Down Expand Up @@ -296,13 +296,13 @@ Other useful metrics to track:

If you use and love this project, please consider contributing.

1. If you see something, say something. [Issues][16] help improve the quality of the project.
* Include relevant logs and package versions for bugs.
* When possible, describe the use-case behind feature requests.
3. [Pull requests][17] are welcome.
* Run `npm run build` before submitting to make sure all tests pass.
* Allow edits from maintainers so small adjustments can be made easily.
3. Consider [sponsoring][15] the project to show your support and optionally get your name listed below.
1. 🪳 If you see something, say something. [Issues][16] help improve the quality of the project.
* Include relevant logs and package versions for bugs.
* When possible, describe the use-case behind feature requests.
1. 🛠️ [Pull requests][17] are welcome.
* Run `npm run build` before submitting to make sure all tests pass.
* Allow edits from maintainers so small adjustments can be made easily.
1. 💵 Consider [sponsoring][15] the project to show your support and optionally get your name listed below.

## Other Options

Expand Down

0 comments on commit b0a0eb6

Please sign in to comment.