mirror of
https://github.com/SableClient/Sable.git
synced 2026-11-21 09:31:17 -08:00
Add additional Obtainium information and fix typo in docker documentation (#1262)
### Description Add a guide for adding the Android app via Obtainium and correct the tags in the Docker portion of the README. #### Type of change - [ ] Bug fix (non-breaking change which fixes an issue) - [x] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) - [ ] This change requires a documentation update ### Checklist: - [ ] My code follows the style guidelines of this project - [ ] I have performed a self-review of my own code - [ ] I have commented my code, particularly in hard-to-understand areas - [x] I have made corresponding changes to the documentation - [x] My changes generate no new warnings ### AI disclosure: - [ ] Partially AI assisted (clarify which code was AI assisted and briefly explain what it does). - [ ] Fully AI generated (explain what all the generated code does in moderate detail). No AI was used in making of this documentation
This commit is contained in:
1 file changed
+10
-1
@@ -41,6 +41,14 @@ Android APKs are published to every release, and [Obtainium](https://obtainium.i
|
||||
|
||||
Android builds are produced by the `android` job in [`tauri-build.yml`](.github/workflows/tauri-build.yml), and the config by the `obtainium` job in the same workflow.
|
||||
|
||||
### Relevant variables and switching between Nightly and Stable
|
||||
|
||||
Relevant variable differences between Nightly and Stable:
|
||||
- *Include prereleases* - `true` for Nightly, `false` for Stable
|
||||
- *Fallback to older releases* - `false` for Nightly, `true` for Stable
|
||||
- *Use latest asset upload as release date* - `true` for Nightly, `false` for Stable (this is due to Nightly builds being uploaded to one release instead of creating new ones)
|
||||
- *Use release date as version string (pseudo-version)* - `true` for Nightly, `false` for Stable (this is due to Nightly builds being uploaded to one release instead of creating new ones)
|
||||
|
||||
## iOS (AltStore / SideStore)
|
||||
|
||||
Sable iOS builds are distributed as unsigned IPAs through [AltStore](https://altstore.io) and [SideStore](https://sidestore.io). Each release publishes both the IPA and an `altstore-source.json` manifest — stable builds to the [latest GitHub release](https://github.com/SableClient/Sable/releases/latest), nightly builds to the [`nightly` GitHub release](https://github.com/SableClient/Sable/releases/tag/nightly).
|
||||
@@ -83,7 +91,8 @@ You have a few options for self hosting, you can:
|
||||
|
||||
Prebuilt images are published to `ghcr.io/sableclient/sable`.
|
||||
|
||||
- `latest` tracks the current `dev` branch image.
|
||||
- `latest` tracks the current latest version release.
|
||||
- `dev` tracks the current `dev` branch image.
|
||||
- `X.Y.Z` tags are versioned releases.
|
||||
- `X.Y` tags float within a release line.
|
||||
- Pushes to `dev` also publish a short commit SHA tag.
|
||||
|
||||
Reference in new issue
Block a user