diff --git a/README.md b/README.md index b29c910..8a9a110 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,19 @@ # ADB Wi-Fi ![Build](https://github.com/y-polek/ADB-Wi-Fi/workflows/Build/badge.svg) -[![Version](https://img.shields.io/jetbrains/plugin/v/PLUGIN_ID.svg)](https://plugins.jetbrains.com/plugin/PLUGIN_ID) -[![Downloads](https://img.shields.io/jetbrains/plugin/d/PLUGIN_ID.svg)](https://plugins.jetbrains.com/plugin/PLUGIN_ID) - -## Template ToDo list -- [x] Create a new [IntelliJ Platform Plugin Template][template] project. -- [ ] Verify the [pluginGroup](/gradle.properties), [plugin ID](/src/main/resources/META-INF/plugin.xml) and [sources package](/src/main/kotlin). -- [ ] Review the [Legal Agreements](https://plugins.jetbrains.com/docs/marketplace/legal-agreements.html). -- [ ] [Publish a plugin manually](https://www.jetbrains.org/intellij/sdk/docs/basics/getting_started/publishing_plugin.html) for the first time. -- [ ] Set the Plugin ID in the above README badges. -- [ ] Set the [Deployment Token](https://plugins.jetbrains.com/docs/marketplace/plugin-upload.html). -- [ ] Click the Watch button on the top of the [IntelliJ Platform Plugin Template][template] to be notified about releases containing new features and fixes. +[![Version](https://img.shields.io/jetbrains/plugin/v/14969.svg)](https://plugins.jetbrains.com/plugin/14969) +[![Downloads](https://img.shields.io/jetbrains/plugin/d/14969.svg)](https://plugins.jetbrains.com/plugin/14969) -This Fancy IntelliJ Platform Plugin is going to be your implementation of the brilliant ideas that you have. +This plugin simplifies the usage of [ADB][adb]'s ["Connect over Wi-Fi"][adb#wireless] feature. -This specific section is a source for the [plugin.xml](/src/main/resources/META-INF/plugin.xml) file which will be -extracted by the [Gradle](/build.gradle.kts) during the build process. - -To keep everything working, do not remove `` sections. +## How to Use +1. Connect an Android device via USB cable. +2. Open the "ADB Wi-Fi" Tool Window (in the right-bottom corner). +3. Click the "Connect" button. +4. After a successful connection, you can unplug the USB cable. +![Connect device](./docs/connect.gif) + ## Installation @@ -34,8 +28,5 @@ To keep everything working, do not remove `` sections. Download the [latest release](https://github.com/y-polek/ADB-Wi-Fi/releases/latest) and install it manually using Preferences > Plugins > ⚙️ > Install plugin from disk... - ---- -Plugin based on the [IntelliJ Platform Plugin Template][template]. - -[template]: https://github.com/JetBrains/intellij-platform-plugin-template +[adb]: https://developer.android.com/studio/command-line/adb +[adb#wireless]: https://developer.android.com/studio/command-line/adb#wireless diff --git a/docs/connect.gif b/docs/connect.gif new file mode 100644 index 0000000..0e4c919 Binary files /dev/null and b/docs/connect.gif differ