shipthis 0.0.30 → 0.0.32

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" srcset="https://shipthis.cc/logo_darkmode.svg">
+      <img height="56" width="260" alt="ShipThis" src="https://shipthis.cc/logo_darkmode.svg" ></img>
+    </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,12 +59,20 @@ 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

package/docs/README.md

@@ -1,60 +1,11 @@
-# ShipThis CLI
+# ShipThis CLI Reference
 
-## Introduction
+**ShipThis** is a **command-line tool** which manages releasing your [Godot](https://godotengine.org/) games to the **iOS App Store**.
 
-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.
+:::tip New to ShipThis?
+Begin with our [Quickstart Guide](/docs/quickstart).
 :::
 
-## 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.
-- An [Apple Developer](https://developer.apple.com) account
-
-### 1. Install ShipThis
-
-ShipThis can be installed as a package via the [NPM package manager](https://www.npmjs.com/). Run the following at the command line:
-
-```bash
-npm install -g shipthis
-```
-
-### 2. Create an account
-
-Set up an account with ShipThis by logging in for the first time using the [`shipthis login`](https://shipthis.cc/docs/reference/login) command.
-
-```bash
-shipthis login
-```
-
-### 3. Configure your game
-
-Set up your ShipThis configuration using the built in [wizard](https://shipthis.cc/docs/wizard):
-
-```bash
-shipthis game wizard
-```
-
-### 4. Ship
-
-Now you can publish your game to TestFlight with the [`shipthis game ship`](https://shipthis.cc/docs/reference/game/ship) command:
-
-```bash
-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
 
 - [apple](https://shipthis.cc/docs/reference/apple) - Commands that relate to linking your ShipThis account with your Apple Developer Account

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/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

@@ -514,10 +514,10 @@
         "wizard.js"
       ]
     },
-    "apple:certificate:create": {
+    "apple:apiKey:create": {
       "aliases": [],
       "args": {},
-      "description": "Creates an iOS Distribution Certificate in your Apple Developer account.\nSaves the certificate with the private key to your ShipThis account",
+      "description": "Creates an App Store Connect API Key in your Apple Developer account.\nSaves the private key in your ShipThis account.",
       "examples": [
         "<%= config.bin %> <%= command.id %>",
         "<%= config.bin %> <%= command.id %> --force"
@@ -539,7 +539,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "apple:certificate:create",
+      "id": "apple:apiKey:create",
       "pluginAlias": "shipthis",
       "pluginName": "shipthis",
       "pluginType": "core",
@@ -549,11 +549,11 @@
         "dist",
         "commands",
         "apple",
-        "certificate",
+        "apiKey",
         "create.js"
       ]
     },
-    "apple:certificate:export": {
+    "apple:apiKey:export": {
       "aliases": [],
       "args": {
         "file": {
@@ -562,9 +562,9 @@
           "required": true
         }
       },
-      "description": "Saves the current Apple Distribution Certificate to a ZIP file.",
+      "description": "Saves the current App Store Connect API Key to a ZIP file",
       "examples": [
-        "<%= config.bin %> <%= command.id %> userCert.zip"
+        "<%= config.bin %> <%= command.id %> userApiKey.zip"
       ],
       "flags": {
         "force": {
@@ -577,7 +577,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "apple:certificate:export",
+      "id": "apple:apiKey:export",
       "pluginAlias": "shipthis",
       "pluginName": "shipthis",
       "pluginType": "core",
@@ -588,11 +588,11 @@
         "dist",
         "commands",
         "apple",
-        "certificate",
+        "apiKey",
         "export.js"
       ]
     },
-    "apple:certificate:import": {
+    "apple:apiKey:import": {
       "aliases": [],
       "args": {
         "file": {
@@ -601,9 +601,9 @@
           "required": true
         }
       },
-      "description": "Imports an iOS Distribution Certificate to your ShipThis account",
+      "description": "Imports an App Store Connect API Key ZIP file into your ShipThis account",
       "examples": [
-        "<%= config.bin %> <%= command.id %> userCert.zip"
+        "<%= config.bin %> <%= command.id %> userApiKey.zip"
       ],
       "flags": {
         "force": {
@@ -615,7 +615,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "apple:certificate:import",
+      "id": "apple:apiKey:import",
       "pluginAlias": "shipthis",
       "pluginName": "shipthis",
       "pluginType": "core",
@@ -626,14 +626,14 @@
         "dist",
         "commands",
         "apple",
-        "certificate",
+        "apiKey",
         "import.js"
       ]
     },
-    "apple:certificate:status": {
+    "apple:apiKey:status": {
       "aliases": [],
       "args": {},
-      "description": "Displays the status of the iOS Distribution certificates in your Apple and ShipThis accounts.\nThese are used to sign all of your iOS apps.",
+      "description": "Displays the status of App Store Connect API Keys in your Apple and ShipThis accounts.\nThis API key is used to automatically publish your games to the App Store.",
       "examples": [
         "<%= config.bin %> <%= command.id %>",
         "<%= config.bin %> <%= command.id %> --noAppleAuth"
@@ -648,7 +648,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "apple:certificate:status",
+      "id": "apple:apiKey:status",
       "pluginAlias": "shipthis",
       "pluginName": "shipthis",
       "pluginType": "core",
@@ -659,14 +659,14 @@
         "dist",
         "commands",
         "apple",
-        "certificate",
+        "apiKey",
         "status.js"
       ]
     },
-    "apple:apiKey:create": {
+    "apple:certificate:create": {
       "aliases": [],
       "args": {},
-      "description": "Creates an App Store Connect API Key in your Apple Developer account.\nSaves the private key in your ShipThis account.",
+      "description": "Creates an iOS Distribution Certificate in your Apple Developer account.\nSaves the certificate with the private key to your ShipThis account",
       "examples": [
         "<%= config.bin %> <%= command.id %>",
         "<%= config.bin %> <%= command.id %> --force"
@@ -688,7 +688,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "apple:apiKey:create",
+      "id": "apple:certificate:create",
       "pluginAlias": "shipthis",
       "pluginName": "shipthis",
       "pluginType": "core",
@@ -698,11 +698,11 @@
         "dist",
         "commands",
         "apple",
-        "apiKey",
+        "certificate",
         "create.js"
       ]
     },
-    "apple:apiKey:export": {
+    "apple:certificate:export": {
       "aliases": [],
       "args": {
         "file": {
@@ -711,9 +711,9 @@
           "required": true
         }
       },
-      "description": "Saves the current App Store Connect API Key to a ZIP file",
+      "description": "Saves the current Apple Distribution Certificate to a ZIP file.",
       "examples": [
-        "<%= config.bin %> <%= command.id %> userApiKey.zip"
+        "<%= config.bin %> <%= command.id %> userCert.zip"
       ],
       "flags": {
         "force": {
@@ -726,7 +726,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "apple:apiKey:export",
+      "id": "apple:certificate:export",
       "pluginAlias": "shipthis",
       "pluginName": "shipthis",
       "pluginType": "core",
@@ -737,11 +737,11 @@
         "dist",
         "commands",
         "apple",
-        "apiKey",
+        "certificate",
         "export.js"
       ]
     },
-    "apple:apiKey:import": {
+    "apple:certificate:import": {
       "aliases": [],
       "args": {
         "file": {
@@ -750,9 +750,9 @@
           "required": true
         }
       },
-      "description": "Imports an App Store Connect API Key ZIP file into your ShipThis account",
+      "description": "Imports an iOS Distribution Certificate to your ShipThis account",
       "examples": [
-        "<%= config.bin %> <%= command.id %> userApiKey.zip"
+        "<%= config.bin %> <%= command.id %> userCert.zip"
       ],
       "flags": {
         "force": {
@@ -764,7 +764,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "apple:apiKey:import",
+      "id": "apple:certificate:import",
       "pluginAlias": "shipthis",
       "pluginName": "shipthis",
       "pluginType": "core",
@@ -775,14 +775,14 @@
         "dist",
         "commands",
         "apple",
-        "apiKey",
+        "certificate",
         "import.js"
       ]
     },
-    "apple:apiKey:status": {
+    "apple:certificate:status": {
       "aliases": [],
       "args": {},
-      "description": "Displays the status of App Store Connect API Keys in your Apple and ShipThis accounts.\nThis API key is used to automatically publish your games to the App Store.",
+      "description": "Displays the status of the iOS Distribution certificates in your Apple and ShipThis accounts.\nThese are used to sign all of your iOS apps.",
       "examples": [
         "<%= config.bin %> <%= command.id %>",
         "<%= config.bin %> <%= command.id %> --noAppleAuth"
@@ -797,7 +797,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "apple:apiKey:status",
+      "id": "apple:certificate:status",
       "pluginAlias": "shipthis",
       "pluginName": "shipthis",
       "pluginType": "core",
@@ -808,7 +808,7 @@
         "dist",
         "commands",
         "apple",
-        "apiKey",
+        "certificate",
         "status.js"
       ]
     },
@@ -1508,5 +1508,5 @@
       ]
     }
   },
-  "version": "0.0.30"
+  "version": "0.0.32"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "shipthis",
   "description": "Game Shipping Tool",
-  "version": "0.0.30",
+  "version": "0.0.32",
   "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",