shipthis 0.0.29 → 0.0.31

package/README.md

@@ -1,22 +1,27 @@
-# ShipThis CLI
-
-## Introduction
-
-ShipThis is a tool which helps you manage releasing your [Godot](https://godotengine.org/) games to the iOS App Store.
-
-:::tip Info
-You don't need an Apple computer to use ShipThis.
-:::
-
-## Quickstart
-
-Let's discover **ShipThis in less than 5 minutes**.
-
-### What you'll need
-
-- A Godot game
-- [Node.js](https://nodejs.org/en/download/) version 18.0 or above:
-  - When installing Node.js, you are recommended to check all checkboxes related to dependencies.
+<h1 align="center">
+  <a href="https://shipthis.cc">
+    <picture>
+      <source height="56" width="260" media="(prefers-color-scheme: dark)" srcset="https://shipthis.cc/logo_darkmode.svg">
+      <img height="56" width="260" alt="ShipThis" src="https://shipthis.cc/logo_normal.svg">
+    </picture>
+  </a>
+  <br>
+  <a href="https://discord.gg/rHhguPjZ">
+    <img src="https://img.shields.io/discord/1304144717239554069?style=flat-square&label=%F0%9F%92%AC%20discord&color=00ACD7">
+  </a>
+</h1>
+<p align="center">
+  <em><b>ShipThis</b> is a <b>command line tool</b> which manages releasing your <a href="https://godotengine.org/">Godot</a> games to the <b>iOS App Store</b>. Designed to compile and upload your Godot games in the cloud, meaning <b>you do not need to install or run Xcode to release an iOS game</b>.</em>
+</p>
+
+---
+
+## ⚡️ Quickstart
+
+### You will need
+
+- A Godot 3.6 or 4.3 game
+- [Node.js](https://nodejs.org/en/download/) version 18.0 or above
 - An [Apple Developer](https://developer.apple.com) account
 
 ### 1. Install ShipThis
@@ -37,7 +42,7 @@ shipthis login
 
 ### 3. Configure your game
 
-Set up your ShipThis configuration using the built in [wizard](https://shipthis.cc/docs/wizard):
+Set up your ShipThis configuration using the built in [wizard](https://shipthis.cc/docs/wizard). Run this command from within a Godot game directory (with a project.godot file):
 
 ```bash
 shipthis game wizard
@@ -54,14 +59,46 @@ shipthis game ship
 Once you are happy with the build you can submit it to Apple using [App Store
 Connect](https://appstoreconnect.apple.com/).
 
-## Topics
+Re-run the `shipthis game ship` command each time you want to build a new release of your game. **You never need to run Xcode**.
+
+### Next Steps
+
+- Checkout the [ShipThis Tutorial](https://shipthis.cc/docs/tutorial)
+
+## 📖 Command Reference
+
+### Topics
 
 - [apple](https://shipthis.cc/docs/reference/apple) - Commands that relate to linking your ShipThis account with your Apple Developer Account
 - [game](https://shipthis.cc/docs/reference/game) - Commands that relate to configuring the specific game in the current working directory.
 
-## Commands
+### Commands
 
 - [dashboard](https://shipthis.cc/docs/reference/dashboard) - Opens the web browser to your shipthis.cc dashboard
 - [login](https://shipthis.cc/docs/reference/login) - Signin or create a new account
 - [status](https://shipthis.cc/docs/reference/status) - Display your overall ShipThis account status
 - [help](https://shipthis.cc/docs/reference/help) - Display help for a specific topic or command
+
+@octocat :+1: This PR looks great - it's ready to merge! :shipit:
+
+> [!NOTE]  
+> Highlights information that users should take into account, even when skimming.
+
+> [!TIP]
+> Optional information to help a user be more successful.
+
+> [!IMPORTANT]  
+> Crucial information necessary for users to succeed.
+
+> [!WARNING]  
+> Critical content demanding immediate user attention due to potential risks.
+
+> [!CAUTION]
+> Negative potential consequences of an action.
+
+<details>
+  <summary>📚 Test</summary>
+
+# This is a test
+
+</details>

package/docs/README.md

@@ -1,22 +1,27 @@
-# ShipThis CLI
-
-## Introduction
-
-ShipThis is a tool which helps you manage releasing your [Godot](https://godotengine.org/) games to the iOS App Store.
-
-:::tip Info
-You don't need an Apple computer to use ShipThis.
-:::
-
-## Quickstart
-
-Let's discover **ShipThis in less than 5 minutes**.
-
-### What you'll need
-
-- A Godot game
-- [Node.js](https://nodejs.org/en/download/) version 18.0 or above:
-  - When installing Node.js, you are recommended to check all checkboxes related to dependencies.
+<h1 align="center">
+  <a href="https://shipthis.cc">
+    <picture>
+      <source height="56" width="260" media="(prefers-color-scheme: dark)" srcset="https://shipthis.cc/logo_darkmode.svg">
+      <img height="56" width="260" alt="ShipThis" src="https://shipthis.cc/logo_normal.svg">
+    </picture>
+  </a>
+  <br>
+  <a href="https://discord.gg/rHhguPjZ">
+    <img src="https://img.shields.io/discord/1304144717239554069?style=flat-square&label=%F0%9F%92%AC%20discord&color=00ACD7">
+  </a>
+</h1>
+<p align="center">
+  <em><b>ShipThis</b> is a <b>command line tool</b> which manages releasing your <a href="https://godotengine.org/">Godot</a> games to the <b>iOS App Store</b>. Designed to compile and upload your Godot games in the cloud, meaning <b>you do not need to install or run Xcode to release an iOS game</b>.</em>
+</p>
+
+---
+
+## ⚡️ Quickstart
+
+### You will need
+
+- A Godot 3.6 or 4.3 game
+- [Node.js](https://nodejs.org/en/download/) version 18.0 or above
 - An [Apple Developer](https://developer.apple.com) account
 
 ### 1. Install ShipThis
@@ -37,7 +42,7 @@ shipthis login
 
 ### 3. Configure your game
 
-Set up your ShipThis configuration using the built in [wizard](https://shipthis.cc/docs/wizard):
+Set up your ShipThis configuration using the built in [wizard](https://shipthis.cc/docs/wizard). Run this command from within a Godot game directory (with a project.godot file):
 
 ```bash
 shipthis game wizard
@@ -54,15 +59,47 @@ shipthis game ship
 Once you are happy with the build you can submit it to Apple using [App Store
 Connect](https://appstoreconnect.apple.com/).
 
+Re-run the `shipthis game ship` command each time you want to build a new release of your game. **You never need to run Xcode**.
+
+### Next Steps
+
+- Checkout the [ShipThis Tutorial](https://shipthis.cc/docs/tutorial)
+
+## 📖 Command Reference
 
-## Topics
+### Topics
 
 - [apple](https://shipthis.cc/docs/reference/apple) - Commands that relate to linking your ShipThis account with your Apple Developer Account
 - [game](https://shipthis.cc/docs/reference/game) - Commands that relate to configuring the specific game in the current working directory.
 
-## Commands
+### Commands
 
 - [dashboard](https://shipthis.cc/docs/reference/dashboard) - Opens the web browser to your shipthis.cc dashboard
 - [login](https://shipthis.cc/docs/reference/login) - Signin or create a new account
 - [status](https://shipthis.cc/docs/reference/status) - Display your overall ShipThis account status
 - [help](https://shipthis.cc/docs/reference/help) - Display help for a specific topic or command
+
+@octocat :+1: This PR looks great - it's ready to merge! :shipit:
+
+
+> [!NOTE]  
+> Highlights information that users should take into account, even when skimming.
+
+> [!TIP]
+> Optional information to help a user be more successful.
+
+> [!IMPORTANT]  
+> Crucial information necessary for users to succeed.
+
+> [!WARNING]  
+> Critical content demanding immediate user attention due to potential risks.
+
+> [!CAUTION]
+> Negative potential consequences of an action.
+
+<details>
+  <summary>📚 Test</summary>
+
+# This is a test
+
+</details>

package/docs/apple/apiKey.md

@@ -5,7 +5,7 @@
 Commands in the apple apiKey topic are prefixed `shipthis apple apiKey`. These commands relate to App Store Connect API Keys.
 
 - You can view the App Store Connect API Keys in the [Apple Developer Portal](https://appstoreconnect.apple.com/access/integrations/api).
-- You can view the keys which ShipThis can use in the [ShipThis Dashboard](https://shipthis.cc/credentials)
+- You can view the keys which ShipThis can use in the [ShipThis Dashboard](https://shipthis.cc/credentials).
 
 :::info
 An **App Store Connect API key** is used to authenticate and authorize automated interactions with Apple's App Store Connect API, enabling tasks like managing app metadata, TestFlight, and sales reports.

package/docs/apple/certificate.md

@@ -24,6 +24,8 @@ these commands. To do that please run the following commands first:
 
 ## Example
 
+[![asciicast](https://asciinema.org/a/Zm53VNoKQx2n0Qrj0UMLIDHHZ.svg)](https://asciinema.org/a/Zm53VNoKQx2n0Qrj0UMLIDHHZ)
+
 ## Commands
 
 ### `apple certificate create`

package/docs/game/build.md

@@ -17,7 +17,7 @@ your game code. It should not be confused with the command [`shipthis game ship`
 
 ## Commands
 
-### Command: `game build download`
+### `game build download`
 
 #### Description
 
@@ -46,7 +46,7 @@ EXAMPLES
   $ shipthis game build download --gameId 0c179fc4 e4b9a3d7 output.apk
 ```
 
-### Command: `game build list`
+### `game build list`
 
 #### Description
 

package/oclif.manifest.json

@@ -663,6 +663,139 @@
         "status.js"
       ]
     },
+    "game:build:download": {
+      "aliases": [],
+      "args": {
+        "build_id": {
+          "description": "The ID of the build to download",
+          "name": "build_id",
+          "required": true
+        },
+        "file": {
+          "description": "Name of the file to output",
+          "name": "file",
+          "required": true
+        }
+      },
+      "description": "Downloads the given build artifact to the specified file",
+      "examples": [
+        "<%= config.bin %> <%= command.id %> 7a3f5c92 output.ipa",
+        "<%= config.bin %> <%= command.id %> --gameId 0c179fc4 e4b9a3d7 output.apk"
+      ],
+      "flags": {
+        "gameId": {
+          "char": "g",
+          "description": "The ID of the game",
+          "name": "gameId",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "force": {
+          "char": "f",
+          "description": "Overwrite the file if it already exists",
+          "name": "force",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "game:build:download",
+      "pluginAlias": "shipthis",
+      "pluginName": "shipthis",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "game",
+        "build",
+        "download.js"
+      ]
+    },
+    "game:build:list": {
+      "aliases": [],
+      "args": {},
+      "description": "Lists the builds for successful jobs of a game.",
+      "examples": [
+        "<%= config.bin %> <%= command.id %>",
+        "<%= config.bin %> <%= command.id %> --gameId 0c179fc4",
+        "<%= config.bin %> <%= command.id %> --gameId 0c179fc4 --pageSize 20 --pageNumber 1"
+      ],
+      "flags": {
+        "gameId": {
+          "char": "g",
+          "description": "The ID of the game",
+          "name": "gameId",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "pageNumber": {
+          "char": "p",
+          "description": "The page number to show (starts at 0)",
+          "name": "pageNumber",
+          "default": 0,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "pageSize": {
+          "char": "s",
+          "description": "The number of items to show per page",
+          "name": "pageSize",
+          "default": 10,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "orderBy": {
+          "char": "o",
+          "description": "The field to order by",
+          "name": "orderBy",
+          "default": "createdAt",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "createdAt",
+            "updatedAt"
+          ],
+          "type": "option"
+        },
+        "order": {
+          "char": "r",
+          "description": "The order to sort by",
+          "name": "order",
+          "default": "desc",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "asc",
+            "desc"
+          ],
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "game:build:list",
+      "pluginAlias": "shipthis",
+      "pluginName": "shipthis",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "game",
+        "build",
+        "list.js"
+      ]
+    },
     "apple:apiKey:create": {
       "aliases": [],
       "args": {},
@@ -812,67 +945,13 @@
         "status.js"
       ]
     },
-    "game:build:download": {
-      "aliases": [],
-      "args": {
-        "build_id": {
-          "description": "The ID of the build to download",
-          "name": "build_id",
-          "required": true
-        },
-        "file": {
-          "description": "Name of the file to output",
-          "name": "file",
-          "required": true
-        }
-      },
-      "description": "Downloads the given build artifact to the specified file",
-      "examples": [
-        "<%= config.bin %> <%= command.id %> 7a3f5c92 output.ipa",
-        "<%= config.bin %> <%= command.id %> --gameId 0c179fc4 e4b9a3d7 output.apk"
-      ],
-      "flags": {
-        "gameId": {
-          "char": "g",
-          "description": "The ID of the game",
-          "name": "gameId",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
-        "force": {
-          "char": "f",
-          "description": "Overwrite the file if it already exists",
-          "name": "force",
-          "allowNo": false,
-          "type": "boolean"
-        }
-      },
-      "hasDynamicHelp": false,
-      "hiddenAliases": [],
-      "id": "game:build:download",
-      "pluginAlias": "shipthis",
-      "pluginName": "shipthis",
-      "pluginType": "core",
-      "strict": true,
-      "enableJsonFlag": false,
-      "isESM": true,
-      "relativePath": [
-        "dist",
-        "commands",
-        "game",
-        "build",
-        "download.js"
-      ]
-    },
-    "game:build:list": {
+    "game:ios:status": {
       "aliases": [],
       "args": {},
-      "description": "Lists the builds for successful jobs of a game.",
+      "description": "Shows the Game iOS Platform status. If --gameId is not provided it will look in the current directory.",
       "examples": [
         "<%= config.bin %> <%= command.id %>",
-        "<%= config.bin %> <%= command.id %> --gameId 0c179fc4",
-        "<%= config.bin %> <%= command.id %> --gameId 0c179fc4 --pageSize 20 --pageNumber 1"
+        "<%= config.bin %> <%= command.id %> --gameId 0c179fc4"
       ],
       "flags": {
         "gameId": {
@@ -882,55 +961,11 @@
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
-        },
-        "pageNumber": {
-          "char": "p",
-          "description": "The page number to show (starts at 0)",
-          "name": "pageNumber",
-          "default": 0,
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
-        "pageSize": {
-          "char": "s",
-          "description": "The number of items to show per page",
-          "name": "pageSize",
-          "default": 10,
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
-        "orderBy": {
-          "char": "o",
-          "description": "The field to order by",
-          "name": "orderBy",
-          "default": "createdAt",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "options": [
-            "createdAt",
-            "updatedAt"
-          ],
-          "type": "option"
-        },
-        "order": {
-          "char": "r",
-          "description": "The order to sort by",
-          "name": "order",
-          "default": "desc",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "options": [
-            "asc",
-            "desc"
-          ],
-          "type": "option"
         }
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "game:build:list",
+      "id": "game:ios:status",
       "pluginAlias": "shipthis",
       "pluginName": "shipthis",
       "pluginType": "core",
@@ -941,8 +976,8 @@
         "dist",
         "commands",
         "game",
-        "build",
-        "list.js"
+        "ios",
+        "status.js"
       ]
     },
     "game:job:list": {
@@ -1082,41 +1117,6 @@
         "status.js"
       ]
     },
-    "game:ios:status": {
-      "aliases": [],
-      "args": {},
-      "description": "Shows the Game iOS Platform status. If --gameId is not provided it will look in the current directory.",
-      "examples": [
-        "<%= config.bin %> <%= command.id %>",
-        "<%= config.bin %> <%= command.id %> --gameId 0c179fc4"
-      ],
-      "flags": {
-        "gameId": {
-          "char": "g",
-          "description": "The ID of the game",
-          "name": "gameId",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        }
-      },
-      "hasDynamicHelp": false,
-      "hiddenAliases": [],
-      "id": "game:ios:status",
-      "pluginAlias": "shipthis",
-      "pluginName": "shipthis",
-      "pluginType": "core",
-      "strict": true,
-      "enableJsonFlag": false,
-      "isESM": true,
-      "relativePath": [
-        "dist",
-        "commands",
-        "game",
-        "ios",
-        "status.js"
-      ]
-    },
     "game:ios:app:addTester": {
       "aliases": [],
       "args": {},
@@ -1508,5 +1508,5 @@
       ]
     }
   },
-  "version": "0.0.29"
+  "version": "0.0.31"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "shipthis",
   "description": "Game Shipping Tool",
-  "version": "0.0.29",
+  "version": "0.0.31",
   "author": "Hello Invent Ltd",
   "bin": {
     "shipthis": "./bin/run.js"
@@ -80,7 +80,11 @@
   ],
   "homepage": "https://shipthis.cc",
   "keywords": [
-    "oclif"
+    "godot",
+    "apple",
+    "ios",
+    "mobile",
+    "game"
   ],
   "license": "MIT",
   "main": "dist/index.js",