diff --git a/CHANGELOG.md b/CHANGELOG.md index 3da11b2..c77a178 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,12 @@ Add entries under **Unreleased** in each pull request. The *Bump version* workfl ## [Unreleased] +### Added +- MIT license, code of conduct, and a demo GIF in the README. + +### Changed +- README install lines use a `LATEST_VERSION` placeholder that matches the JitPack badge, plus a version catalog example. + ## [1.0.0] - 2026-10-24 First stable release. The public API now follows semantic versioning: breaking changes only in a new major version. diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..f5b804b --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,9 @@ +# Code of conduct + +DevDeck follows the [Contributor Covenant, version 2.1](https://www.contributor-covenant.org/version/2/1/code_of_conduct/). + +In short: be welcoming, respectful and constructive in issues, pull requests and discussions. Harassment, insults and personal attacks are not accepted. + +## Reporting + +If someone's behaviour concerns you, contact the maintainer, [@abhishek-3289](https://github.com/abhishek-3289), privately on GitHub. Reports are handled confidentially, and the maintainer may edit or remove comments, close threads or block people who break this code. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 41d52e8..39329e7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -29,12 +29,12 @@ DevDeck uses [Semantic Versioning](https://semver.org/). The version lives in on | Release type | Example | Use for | |---|---|---| - | `fix` | 0.1.0 → **0.1.1** | Bug fixes only | - | `feature` | 0.1.0 → **0.2.0** | New features or behaviour changes | + | `fix` | 1.0.0 → **1.0.1** | Bug fixes only | + | `feature` | 1.0.0 → **1.1.0** | New features or behaviour changes | | `major` | 0.x → **1.0.0**, then 1.x → **2.0.0** | The first stable release, and later breaking changes: removed or renamed public API, changed defaults | | `auto` (default) | — | Picks one from the `[Unreleased]` entries in `CHANGELOG.md`: `### Removed` or the word `BREAKING` → major; `### Added` / `### Changed` → feature; only `### Fixed` → fix. While on 0.x, breaking changes stay a feature release, so 1.0.0 only happens when you choose `major` | - It updates `VERSION_NAME`, moves the *Unreleased* changelog entries under the new version, updates the README's dependency lines, and opens a **Release vX.Y.Z** pull request. + It updates `VERSION_NAME`, moves the *Unreleased* changelog entries under the new version, and opens a **Release vX.Y.Z** pull request. 2. Merge that pull request. The **Release** workflow then: - builds and tests, - creates the `vX.Y.Z` tag and a GitHub release with the changelog notes, diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..6d81b41 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2026 Abhishek Bansal + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index 9e78b24..a9aaa2c 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,7 @@ [![CI](https://github.com/appshipkit/devdeck/actions/workflows/ci.yml/badge.svg?branch=main&event=push)](https://github.com/appshipkit/devdeck/actions/workflows/ci.yml?query=branch%3Amain) [![JitPack](https://jitpack.io/v/appshipkit/devdeck.svg)](https://jitpack.io/#appshipkit/devdeck) +[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE) A debug drawer for Android apps, built with Jetpack Compose. Open it with a two-finger swipe, a floating button, a keyboard shortcut or code, and get your team's debug tools in one place: @@ -15,6 +16,10 @@ A debug drawer for Android apps, built with Jetpack Compose. Open it with a two- Everything is a plugin: pick the ones you need or write your own in a few lines. It works on Compose and classic View screens, and it never ships in release builds. +

+ DevDeck sample app: opening the drawer, feature flags, network simulator, network inspector, breadcrumbs, test build updates, UI tools and permissions +

+ --- ## Setup @@ -29,13 +34,27 @@ dependencyResolutionManagement { // app/build.gradle.kts dependencies { - debugImplementation("com.github.appshipkit.devdeck:devdeck:v1.0.0") - debugImplementation("com.github.appshipkit.devdeck:devdeck-okhttp:v1.0.0") // optional: network inspector (OkHttp / Apollo) - debugImplementation("com.github.appshipkit.devdeck:devdeck-timber:v1.0.0") // optional: Timber logs - debugImplementation("com.github.appshipkit.devdeck:devdeck-appdistribution:v1.0.0") // optional: Firebase test build updates + debugImplementation("com.github.appshipkit.devdeck:devdeck:LATEST_VERSION") + debugImplementation("com.github.appshipkit.devdeck:devdeck-okhttp:LATEST_VERSION") // optional: network inspector (OkHttp / Apollo) + debugImplementation("com.github.appshipkit.devdeck:devdeck-timber:LATEST_VERSION") // optional: Timber logs + debugImplementation("com.github.appshipkit.devdeck:devdeck-appdistribution:LATEST_VERSION") // optional: Firebase test build updates } ``` +Replace `LATEST_VERSION` with the version on the [JitPack badge](https://jitpack.io/#appshipkit/devdeck) above, for example `1.0.0`. JitPack accepts the version with or without the `v` of the git tag, so `1.0.0` and `v1.0.0` give the same build. + +Using a version catalog: + +```toml +# gradle/libs.versions.toml +[versions] +devdeck = "LATEST_VERSION" + +[libraries] +devdeck = { module = "com.github.appshipkit.devdeck:devdeck", version.ref = "devdeck" } +devdeck-okhttp = { module = "com.github.appshipkit.devdeck:devdeck-okhttp", version.ref = "devdeck" } +``` + ### 2. Install it ```kotlin @@ -226,7 +245,7 @@ With Firebase App Distribution: ```kotlin // app/build.gradle.kts, in the variants testers install (never in the Play Store build) -debugImplementation("com.github.appshipkit.devdeck:devdeck-appdistribution:v1.0.0") +debugImplementation("com.github.appshipkit.devdeck:devdeck-appdistribution:LATEST_VERSION") debugImplementation("com.google.firebase:firebase-appdistribution:16.0.0-beta21") // Application.onCreate @@ -372,4 +391,8 @@ Run the `sample` configuration in Android Studio. [sample/README.md](sample/READ ## Contributing -See [CONTRIBUTING.md](CONTRIBUTING.md) for local checks, pull requests and the release process, and [CHANGELOG.md](CHANGELOG.md) for what changed in each version. +See [CONTRIBUTING.md](CONTRIBUTING.md) for local checks, pull requests and the release process, and [CHANGELOG.md](CHANGELOG.md) for what changed in each version. Please follow the [code of conduct](CODE_OF_CONDUCT.md). + +## License + +DevDeck is released under the [MIT License](LICENSE). diff --git a/docs/devdeck-demo.gif b/docs/devdeck-demo.gif new file mode 100644 index 0000000..5171e10 Binary files /dev/null and b/docs/devdeck-demo.gif differ diff --git a/scripts/bump-version.sh b/scripts/bump-version.sh index aedc135..43cb35d 100755 --- a/scripts/bump-version.sh +++ b/scripts/bump-version.sh @@ -46,7 +46,6 @@ esac today=$(date -u +%Y-%m-%d) perl -pi -e "s/^VERSION_NAME=.*/VERSION_NAME=${next}/" gradle.properties -perl -pi -e "s/(com\.github\.appshipkit\.devdeck:devdeck[a-z-]*):v?\Q${current}\E/\1:v${next}/g" README.md perl -pi -e "s/^## \[Unreleased\]\s*\$/## [Unreleased]\n\n## [${next}] - ${today}\n/" CHANGELOG.md echo "${current} -> ${next}"