Add license and readme

LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 chef417
+
+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.

README.md

@@ -1,3 +1,75 @@
-# adbr
+# Android Debug Bridge Recorder (adbr)
 
+The `adbr.sh` is a small bash script that will allow you to easily record Android device/emulator screen. It allows you to take many screen recording by just pressing a key in the terminal.
 
+### Features
+
+- Take a screen recording from connected device/emulator with one key press
+- Specify an output directory for the recordings
+- Automatically clean the temporary recording from the device
+
+### Sample
+
+See the sample of the recording process:
+
+![](res/adbr-demo.gif)
+
+### Usage
+
+* **-o** Specify output directory for recordings, e.g. `adbr -o ~/Desktop/test_dir`
+* **-h** Print help
+* **-v** Print version
+
+Once the program is running, press any key to start/stop recording, or 'q' to exit.
+
+### Installation (Linux and MacOS)
+
+1) Make sure you have ADB in your path. You can add it to your shell config file (`.bash_profile`, `.zshrc`, etc.):
+
+```sh
+# Your ADB might be different, these are just common locations.
+
+# Linux
+export PATH=${PATH}:$HOME/Android/Sdk/platform-tools/
+
+# MacOS
+export PATH=${PATH}:$HOME/Library/Android/sdk/platform-tools/
+```
+
+2) Make sure you have `ffmpeg` installed:
+
+```
+# MacOS
+brew install ffmpeg
+
+# Debian/Ubuntu
+apt-get install ffmpeg
+
+#Arch
+pacman -S ffmpeg
+```
+
+3) Check that you have a device/emulator connected to the ADB by running `adb devices`. Output should look like this:
+
+```sh
+List of devices attached
+emulator-5554   device 
+```
+
+4) You can simply download `adbr.sh` and use it however you like. This is simpler example for nicer integration and easier updates:
+
+```sh
+# Clone adbr repo to your home directory.
+git clone https://github.com/skoric/adbr.git ~/adbr
+
+# Create alias in your shell config file ('.bash_profile', '.zshrc', etc.).
+echo "alias adbr=\"sh $HOME/adbss/adbr.sh\"" >> ~/.zshrc
+
+# Reload configuration.
+source ~/.zshrc
+
+# Start taking screenshots.
+adbr
+```
+
+If you've used the git repo in your setup, you can update by simply calling `git pull` in local repo directory.