From 8a6d0645fc6b1b8518086bc872c64af98db8ec08 Mon Sep 17 00:00:00 2001 From: Vinicios Clarindo Date: Sun, 30 Oct 2022 11:16:46 -0300 Subject: [PATCH] :memo: docs(readme): remove not allowed svg on readme, distribute sections better for vscocde extensions page --- README.md | 98 ++++++++++++++++++++++++------------------------------- 1 file changed, 42 insertions(+), 56 deletions(-) diff --git a/README.md b/README.md index 5b34d80..78be086 100644 --- a/README.md +++ b/README.md @@ -1,49 +1,64 @@ # 🔌 ADB Interface for VSCode -[![Build Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Fvinicioslc%2Fadb-interface-vscode%2Fbadge%3Fref%3Dproduction&style=flat-square)](https://actions-badge.atrox.dev/vinicioslc/adb-interface-vscode/goto?ref=production) -![Visual Studio Marketplace Version](https://img.shields.io/visual-studio-marketplace/v/vinicioslc.adb-interface-vscode?style=flat-square) -![GitHub](https://img.shields.io/github/license/vinicioslc/adb-interface-vscode?style=flat-square) -![Visual Studio Marketplace Installs](https://img.shields.io/visual-studio-marketplace/i/vinicioslc.adb-interface-vscode?style=flat-square) -![Visual Studio Marketplace Rating (Stars)](https://img.shields.io/visual-studio-marketplace/stars/vinicioslc.adb-interface-vscode?style=flat-square) - +
-[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=vinicioslc_adb-interface-vscode&metric=sqale_rating)](https://sonarcloud.io/dashboard?id=vinicioslc_adb-interface-vscode) -[![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=vinicioslc_adb-interface-vscode&metric=ncloc)](https://sonarcloud.io/dashboard?id=vinicioslc_adb-interface-vscode) -[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=vinicioslc_adb-interface-vscode&metric=bugs)](https://sonarcloud.io/dashboard?id=vinicioslc_adb-interface-vscode) -[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=vinicioslc_adb-interface-vscode&metric=security_rating)](https://sonarcloud.io/dashboard?id=vinicioslc_adb-interface-vscode) + -
+
-This simple ADB-Wrapper try makes easy connect to android devices over wifi, without console use, and do other things. +[![Build Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Fvinicioslc%2Fadb-interface-vscode%2Fbadge%3Fref%3Dproduction&style=flat-square)](https://actions-badge.atrox.dev/vinicioslc/adb-interface-vscode/goto?ref=production) ![Visual Studio Marketplace Version](https://img.shields.io/visual-studio-marketplace/v/vinicioslc.adb-interface-vscode?style=flat-square) ![GitHub](https://img.shields.io/github/license/vinicioslc/adb-interface-vscode?style=flat-square) ![Visual Studio Marketplace Installs](https://img.shields.io/visual-studio-marketplace/i/vinicioslc.adb-interface-vscode?style=flat-square) ![Visual Studio Marketplace Rating (Stars)](https://img.shields.io/visual-studio-marketplace/stars/vinicioslc.adb-interface-vscode?style=flat-square) + -Chinese Guide [įŽ€äŊ“中文指南](https://www.jianshu.com/p/fb8eebc8a2c0) +[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=vinicioslc_adb-interface-vscode&metric=sqale_rating)](https://sonarcloud.io/dashboard?id=vinicioslc_adb-interface-vscode) [![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=vinicioslc_adb-interface-vscode&metric=ncloc)](https://sonarcloud.io/dashboard?id=vinicioslc_adb-interface-vscode) [![Bugs](https://sonarcloud.io/api/project_badges/measure?project=vinicioslc_adb-interface-vscode&metric=bugs)](https://sonarcloud.io/dashboard?id=vinicioslc_adb-interface-vscode) [![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=vinicioslc_adb-interface-vscode&metric=security_rating)](https://sonarcloud.io/dashboard?id=vinicioslc_adb-interface-vscode) +This simple ADB wrapper try to makes easy connect to android devices over wifi, without console use, and do other things. -You can help with -[Code](https://github.com/vinicioslc/adb-interface-vscode/issues) -or with -[Energy](https://www.paypal.com/cgi-bin/webscr?cmd=\_s-xclick&hosted_button_id=TKRZ7F4FV4QY4&source=url) everthing are welcome ;) +Chinese Guide [įŽ€äŊ“中文指南](https://www.jianshu.com/p/fb8eebc8a2c0) + +You can help with [Code](https://github.com/vinicioslc/adb-interface-vscode/issues) or with [Energy](https://www.paypal.com/cgi-bin/webscr?cmd=\_s-xclick&hosted_button_id=TKRZ7F4FV4QY4&source=url) everthing are welcome ;) -[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/K3K424BR8) +Buy Me a Coffee at ko-fi.com > ⚠ī¸ ONLY TESTED IN WINDOWS (For while, you need have ADB Interface installed in your system) -# Table of contents +
- +![status bar](https://raw.githubusercontent.com/vinicioslc/adb-interface-vscode/production/media/record1.gif) -- [Table of contents](#table-of-contents) -- [Commands Available](#commands-available) +
-- [How it works](#how-it-works) +## Attach ADB to an Device via WIFI - - [ADB location resolution strategy](#adb-location-resolution) +1. First connect your device trough USB +2. Run `ADB:📱 Disconnect from any devices` +3. And run `ADB:📱 Reset connected devices port to :5555` +4. And Then `ADB:📱 Connect to device IP` enter your device (settings > status > ip address) IP address and be fine + +
+ +![status bar](/media/install_apk_demo.gif) + +
-- [Demo GIFs](#demos) +## Installing APK files throught ADB +1. Pick apk file with command `ADB:📱 Pick .APK file and install ` +2. Allow ADB install on device screen +3. Wait until copy de file and icon appear +4. Now you can run the APP + +# Table of contents + + + +- [🔌 ADB Interface for VSCode](#-adb-interface-for-vscode) +- 📱 Demo GIFs - [Attach ADB to an Device via WIFI](#attach-adb-to-an-device-via-wifi) - [Installing APK files throught ADB](#installing-apk-files-throught-adb) - +- [Table of contents](#table-of-contents) +- [Commands Available](#commands-available) +- [How it works](#how-it-works) + - [ADB location resolution strategy](#adb-location-resolution) - [Tests](#tests) @@ -75,36 +90,6 @@ The extension will resolve the ADB location each time an ADB command is executed The ADB location can be customized using the `Setup custom ADB location` command. The custom ADB location can be cleared using the `Remove custom ADB location` command. -# Demos - -Below you can see some GIFs demostrating use cases. - -## Attach ADB to an Device via WIFI - -1. First connect your device trough USB -2. Run `ADB:📱 Disconnect from any devices` -3. And run `ADB:📱 Reset connected devices port to :5555` -4. And Then `ADB:📱 Connect to device IP` enter your device (settings > status > ip address) IP address and be fine - -
- -![status bar](https://raw.githubusercontent.com/vinicioslc/adb-interface-vscode/production/media/record1.gif) - -
- -## Installing APK files throught ADB - -1. Pick apk file with command `ADB:📱 Pick .APK file and install ` -2. Allow ADB install on device screen -3. Wait until copy de file and icon appear -4. Now you can run the APP - -
- -![status bar](/media/install_apk_demo.gif) - -
- # Tests All done with [Jest](https://jestjs.io/) you can read more about [here.](https://jestjs.io/docs/en/getting-started.html) @@ -116,6 +101,7 @@ We need help to incrase test coverage report, if you can learn, send a pull requ ```bash âžĨ npm run test ``` + > You can also use the project alias that watch file changes while developing: ```bash