diff --git a/README.md b/README.md index e5e5e6e..c67eef5 100644 --- a/README.md +++ b/README.md @@ -36,6 +36,8 @@ most (if not all) keys are technically optional. here's an example repo with eve } ``` +you can see the output for this example in the `examples/` directory. + ## useful key explanations ### root `identifier` is usually a reverse id. this can really be anything, but i like the reverse domains. diff --git a/example.json b/example.json new file mode 100644 index 0000000..1d42716 --- /dev/null +++ b/example.json @@ -0,0 +1,21 @@ +{ + "name": "hello!", + "identifier": "fyi.zxcvbn.repo.test", + "iconURL": "https://example.com/path/to/some/icon.png", + "caption": "a *short* description of your repo!", + "description": "this can be a longer description and include stuff like your links or something, idk", + "apps": [ + { + "name": "app name", + "developerName": "zx", + "bundleID": "fyi.zxcvbn.app", + "caption": "just like the repo's caption", + "description": "just like the repo's description", + "downloadURL": "https://example.com/path/to/some/app.ipa", + "iconURL": "https://example.com/hopefully/path/to/itunes/icon.png", + "version": "1.2", + "date": "2024-12-18", + "size": 1073741824 + } + ] +} \ No newline at end of file diff --git a/examples/example.altstore.json b/examples/example.altstore.json new file mode 100755 index 0000000..f1dd398 --- /dev/null +++ b/examples/example.altstore.json @@ -0,0 +1,23 @@ +{ + "name": "hello!", + "subtitle": "a *short* description of your repo!", + "description": "this can be a longer description and include stuff like your links or something, idk", + "apps": [ + { + "name": "app name", + "developerName": "zx", + "bundleIdentifier": "fyi.zxcvbn.app", + "localizedDescription": "", + "iconURL": "https://example.com/hopefully/path/to/itunes/icon.png", + "versions": [ + { + "version": "1.2", + "date": "2024-12-18", + "size": 1073741824, + "downloadURL": "https://example.com/path/to/some/app.ipa", + "localizedDescription": "just like the repo's description" + } + ] + } + ] +} \ No newline at end of file diff --git a/examples/example.esign.json b/examples/example.esign.json new file mode 100755 index 0000000..cf0a276 --- /dev/null +++ b/examples/example.esign.json @@ -0,0 +1,16 @@ +{ + "name": "hello!", + "identifier": "fyi.zxcvbn.repo.test", + "apps": [ + { + "name": "app name", + "bundleIdentifier": "fyi.zxcvbn.app", + "localizedDescription": "just like the repo's description", + "downloadURL": "https://example.com/path/to/some/app.ipa", + "iconURL": "https://example.com/hopefully/path/to/itunes/icon.png", + "version": "1.2", + "versionDate": "2024-12-18", + "size": 1073741824 + } + ] +} \ No newline at end of file diff --git a/examples/example.feather.json b/examples/example.feather.json new file mode 100755 index 0000000..094d8da --- /dev/null +++ b/examples/example.feather.json @@ -0,0 +1,16 @@ +{ + "name": "hello!", + "identifier": "fyi.zxcvbn.repo.test", + "apps": [ + { + "name": "app name", + "bundleIdentifier": "fyi.zxcvbn.app", + "subtitle": "just like the repo's caption", + "localizedDescription": "just like the repo's description", + "downloadURL": "https://example.com/path/to/some/app.ipa", + "iconURL": "https://example.com/hopefully/path/to/itunes/icon.png", + "version": "1.2", + "size": 1073741824 + } + ] +} \ No newline at end of file diff --git a/examples/example.gbox.json b/examples/example.gbox.json new file mode 100755 index 0000000..0f5dece --- /dev/null +++ b/examples/example.gbox.json @@ -0,0 +1,17 @@ +{ + "version": "1.0", + "sourceName": "hello!", + "sourceImage": "https://example.com/path/to/some/icon.png", + "sourceDescription": "this can be a longer description and include stuff like your links or something, idk", + "appRepositories": [ + { + "appType": "SELF_SIGN", + "appUpdateTime": "2024-12-18", + "appName": "app name", + "appVersion": "1.2", + "appDescription": "just like the repo's description", + "appImage": "https://example.com/hopefully/path/to/itunes/icon.png", + "appPackage": "https://example.com/path/to/some/app.ipa" + } + ] +} \ No newline at end of file diff --git a/examples/example.scarlet.json b/examples/example.scarlet.json new file mode 100755 index 0000000..51b287f --- /dev/null +++ b/examples/example.scarlet.json @@ -0,0 +1,17 @@ +{ + "META": { + "repoName": "hello!", + "repoIcon": "https://example.com/path/to/some/icon.png" + }, + "Tweaked": [ + { + "name": "app name", + "dev": "zx", + "version": "1.2", + "icon": "https://example.com/hopefully/path/to/itunes/icon.png", + "down": "https://example.com/path/to/some/app.ipa", + "description": "just like the repo's description", + "bundleID": "fyi.zxcvbn.app" + } + ] +} \ No newline at end of file