bendns' repos / godot-template
Godot template repository for my programs
Diffstat (limited to 'README.md')
-rw-r--r--README.md39
1 files changed, 25 insertions, 14 deletions
diff --git a/README.md b/README.md
index 7575a7e..32d39b0 100644
--- a/README.md
+++ b/README.md
@@ -1,37 +1,48 @@
# godot-template
+[![version](https://img.shields.io/badge/3.x-blue?logo=godot-engine&logoColor=white&label=godot&style=for-the-badge)](https://godotengine.org "Made with godot")
+<a href='https://ko-fi.com/bendn' title='Buy me a coffee' target='_blank'><img height='28' src='https://storage.ko-fi.com/cdn/brandasset/kofi_button_red.png' alt='Buy me a coffee'> </a>
+
Godot template repository for my programs
---
-# How to use
+## How to use
-- To use: click use this template button.
-- Clone your repository
-- Add your files
-- Commit
-- Push
+- Click use this template button
+- Clone your new repository
+- Add your files & change `FUNDING.yml`
+- Commit & push
<details>
<summary>For itch.io depoloyment</summary>
<br>
-Add a secret called BUTLER_CREDENTIALS with your butler api key.
+
+Add a secret called `BUTLER_CREDENTIALS` with your [butler api key](https://itch.io/user/settings/api-keys).
+
</details>
<details>
<summary>For android builds</summary>
<br>
+
+> **Note**
+>
+> The keystore user/alias is found automatically.
+
Add two secrets:
- ANDROID_KEYSTORE_BASE64
- ANDROID_KEYSTORE_PASSWORD
+
+- `ANDROID_KEYSTORE_BASE64`
+- `ANDROID_KEYSTORE_PASSWORD`
+
</details>
---
-### Availability:
+### Availability
-| windows | ios | linux | android | mac | html | |
-|:------------------:|:---:|:------------------:|:------------------:|:------------------:|:------------------:|:-------------:|
-| :x: | :x: | :x: | :x: | :x: | :heavy_check_mark: | github pages |
-| :heavy_check_mark: | :x: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | itch.io |
+| windows | ios | linux | android | mac | html | |
+| :----------------: | :-: | :----------------: | :----------------: | :----------------: | :----------------: | :-----------: |
+| :x: | :x: | :x: | :x: | :x: | :heavy_check_mark: | github pages |
+| :heavy_check_mark: | :x: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | itch.io |
| :heavy_check_mark: | :x: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | godot exports |