Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
9 changes: 9 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -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.
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -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.
35 changes: 29 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -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.

<p align="center">
<img src="docs/devdeck-demo.gif" width="300" alt="DevDeck sample app: opening the drawer, feature flags, network simulator, network inspector, breadcrumbs, test build updates, UI tools and permissions" />
</p>

---

## Setup
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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).
Binary file added docs/devdeck-demo.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 0 additions & 1 deletion scripts/bump-version.sh
Original file line number Diff line number Diff line change
Expand Up @@ -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}"
Expand Down
Loading