Simplify READMEs

Author: Wavesonics

.github/workflows/README.md

@@ -1,7 +1,7 @@
 # GitHub Actions Workflows for App Publishing
 
-This directory contains GitHub Actions workflow configurations for automating the build and deployment process of the
-Secure Camera app to both Google Play and GitHub Releases.
+This directory contains GitHub Actions workflow configurations for automating the build and
+deployment process to both Google Play and GitHub Releases.
 
 ## Workflow: Publish Releases
 
@@ -11,25 +11,6 @@ the format `v*` (e.g., `v1.0.0`) is pushed to the repository. It contains two jo
 1. Build and publish to Play Store
 2. Build and publish GitHub release
 
-### Play Store Job Steps
-
-1. Checkout the code
-2. Set up JDK 17
-3. Set up Ruby and install Fastlane
-4. Decode the Android keystore from a base64-encoded secret
-5. Build the release AAB with proper signing
-6. Decode the Google Play service account key
-7. Deploy to Google Play using Fastlane
-
-### GitHub Release Job Steps
-
-1. Checkout the code
-2. Set up JDK 17
-3. Decode a separate Android keystore from a base64-encoded secret
-4. Build a signed release APK
-5. Create a GitHub release
-6. Attach the APK to the release
-
 ### Required Secrets
 
 #### For Play Store Publishing
@@ -67,39 +48,3 @@ The following secrets must be configured in your GitHub repository settings:
 3. **GITHUB_RELEASE_KEY_ALIAS**: Alias of the key in the GitHub release keystore
 
 4. **GITHUB_RELEASE_KEY_PASSWORD**: Password for the key in the GitHub release keystore
-
-### How to Use
-
-1. Set up all the required secrets in your GitHub repository settings:
-   - For Play Store publishing: ENCODED_KEYSTORE, KEYSTORE_PASSWORD, KEY_ALIAS, KEY_PASSWORD, PLAY_STORE_CONFIG_JSON
-   - For GitHub release publishing: GITHUB_RELEASE_ENCODED_KEYSTORE, GITHUB_RELEASE_KEYSTORE_PASSWORD,
-     GITHUB_RELEASE_KEY_ALIAS, GITHUB_RELEASE_KEY_PASSWORD
-2. When you're ready to release a new version:
-    - Update the version information in `gradle/libs.versions.toml`
-    - Commit and push the changes
-    - Create and push a new tag with the format `v1.0.0` (matching your version)
-   ```bash
-   git tag v1.0.0
-   git push origin v1.0.0
-   ```
-3. The workflow will automatically trigger and:
-   - Deploy the app to Google Play
-   - Create a GitHub release with the signed APK attached
-
-### Troubleshooting
-
-If the workflow fails, check the following:
-
-#### For Play Store Publishing
-
-1. Ensure all Play Store secrets are correctly configured
-2. Verify that the keystore is valid and contains the correct key
-3. Make sure the Google Play service account has the necessary permissions
-4. Check that the app's version code has been incremented since the last release
-
-#### For GitHub Release Publishing
-
-1. Ensure all GitHub release secrets are correctly configured
-2. Verify that the GitHub release keystore is valid and contains the correct key
-3. Check that you have the necessary permissions to create releases in the repository
-4. Verify that the APK is being built correctly

README.md

@@ -61,30 +61,24 @@ Attacks come in many forms, from accidental swipes, to intrusive surveillance, a
 
 ---
 
-## Contributing
-
-Pull requests are happily accepted.
+## License
 
-Start with an issue or draft PR and we can talk it through.
+SnapSafe is released under the [MIT License](LICENSE). Use it, fork it, improve it—just keep it open.
 
-### Automated Publishing
+---
 
-The project uses GitHub Actions to automatically build and publish new releases to Google Play when a tag with the
-format `v*` (e.g., `v1.0.0`) is pushed. See the [GitHub Actions workflow documentation](.github/workflows/README.md) for
-details on how this works and the required setup.
+## Privacy
 
-The project includes a pre-configured [FastLane](https://fastlane.tools/) setup for automating the deployment process.
-See the [FastLane documentation](fastlane/README.md) for details on how to use it for manual deployments or to customize
-the metadata.
+Our full, ultra‑brief Privacy Policy lives in [PRIVACY.md](PRIVACY.md). Spoiler: we collect nothing.
 
 ---
 
-## License
+## Development
 
-SnapSafe is released under the [MIT License](LICENSE). Use it, fork it, improve it—just keep it open.
+See [docs/HOW-TO-RELEASE](docs/HOW-TO-RELEASE.md) on how to publish a new release.
 
----
+### Contributing
 
-## Privacy
+Pull requests are happily accepted.
 
-Our full, ultra‑brief Privacy Policy lives in [PRIVACY.md](PRIVACY.md). Spoiler: we collect nothing.
+Start with an issue or draft PR and we can talk it through.

docs/HOW-TO-RELEASE.md

@@ -0,0 +1,15 @@
+# How to publish a new release
+
+- Update `versionCode` and `versionName` in [libs.versions.toml](/gradle/libs.versions.toml)
+- Create a changelog in: `\fastlane\metadata\android\en-US`
+- Create a **semvar** tag in the form of "v1.0.0" on `master` and push it, this will trigger a release.
+
+### Automated Publishing
+
+We use GitHub Actions to automatically build and publish new releases to Google Play when a tag with the
+format `v*` (e.g., `v1.0.0`) is pushed. See the [GitHub Actions workflow documentation](.github/workflows/README.md) for
+details on how this works and the required setup.
+
+The project includes a pre-configured [FastLane](https://fastlane.tools/) setup for automating the deployment process.
+See the [FastLane documentation](fastlane/README.md) for details on how to use it for manual deployments or to customize
+the metadata.