Skip to content

Commit

Permalink
📝 docs(readme): remove not allowed svg on readme, distribute sections…
Browse files Browse the repository at this point in the history
… better for vscocde extensions page
  • Loading branch information
vinicioslc committed Oct 30, 2022
1 parent 55b7ef6 commit 8a6d064
Showing 1 changed file with 42 additions and 56 deletions.
98 changes: 42 additions & 56 deletions README.md
Original file line number Diff line number Diff line change
@@ -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)
<a href="https://codeclimate.com/github/vinicioslc/adb-interface-vscode/maintainability">
<div style="text-align:center">

[![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)
<img src="https://raw.githubusercontent.com/vinicioslc/adb-interface-vscode/production/media/icon.png" width="200" />

<div style="text-align:center"><img src="https://raw.githubusercontent.com/vinicioslc/adb-interface-vscode/production/media/icon.png" width="200" /></div>
</div>

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)
<a href="https://codeclimate.com/github/vinicioslc/adb-interface-vscode/maintainability">

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)
<a href='https://ko-fi.com/K3K424BR8' target='_blank'><img height='36' style='border:0px;height:36px;' src='https://storage.ko-fi.com/cdn/kofi3.png?v=3' border='0' alt='Buy Me a Coffee at ko-fi.com' /></a>

> ⚠️ ONLY TESTED IN WINDOWS (For while, you need have ADB Interface installed in your system)
# Table of contents
<div style="text-align:center">

<!--ts-->
![status bar](https://raw.githubusercontent.com/vinicioslc/adb-interface-vscode/production/media/record1.gif)

- [Table of contents](#table-of-contents)
- [Commands Available](#commands-available)
</div>

- [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

<div style="text-align:center">

![status bar](/media/install_apk_demo.gif)

</div>

- [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

<!--ts-->

- [🔌 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)

<!--te-->
Expand Down Expand Up @@ -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

<div style="text-align:center">

![status bar](https://raw.githubusercontent.com/vinicioslc/adb-interface-vscode/production/media/record1.gif)

</div>

## 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

<div style="text-align:center">

![status bar](/media/install_apk_demo.gif)

</div>

# Tests

All done with [Jest](https://jestjs.io/) you can read more about [here.](https://jestjs.io/docs/en/getting-started.html)
Expand All @@ -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
Expand Down

0 comments on commit 8a6d064

Please sign in to comment.