Add mkdocs, app pre-commit dependency

docs/index.md

@@ -0,0 +1,75 @@
+#### FZF Cloud Select
+
+[![Build Status](https://travis-ci.org/ezh/cloudselect.svg?branch=master)](https://travis-ci.org/ezh/cloudselect)
+[![codecov](https://codecov.io/gh/ezh/cloudselect/branch/master/graph/badge.svg)](https://codecov.io/gh/ezh/cloudselect)
+[![MIT License](https://img.shields.io/badge/license-MIT-007EC7.svg)](/LICENSE)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/cloudselect)](https://pypi.org/project/cloudselect/)
+[![Codacy Badge](https://api.codacy.com/project/badge/Grade/124d1f6ec45e45deaf924e740670087f)](https://www.codacy.com/manual/ezh/cloudselect?utm_source=github.com&utm_medium=referral&utm_content=ezh/cloudselect&utm_campaign=Badge_Grade)
+[![code style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://black.readthedocs.io/en/stable)
+
+## Purpose
+
+We have to jump between nodes quickly. There is a list of cloud accounts. Each account has multiple regions. Some nodes are publicity available, some of them not. Dozen of nodes sit behind bastion hosts. And few of them sit behind a group of jump points. And they all have different SSH keys.
+
+There is a `~/.ssh/config`, but it is not enough because of the dynamic nature of the cloud. It is too clumsy. It is not suitable for cases when IP addresses are changing instantly, and instances are creating and destroying in minutes.
+
+I tried to structure that hell with shell scripts, but the shell is not enough. I believe that tools like *C*/*C++*/*Java*/*Node.JS*/*Go*?/*Rust* are too heavy for this case. Python is the exact thing. I like to have a dynamic and lightweight solution. Cloud Select is fast enough to go through thousands of nodes. Maybe if my scope will be higher, then I'll create something other.
+
+It is useful for diving inside geo-distributed onion enterprise environments with weird security settings.
+
+## Implementation
+
+CloudSelect retrieves node list from the cloud, passes that list to FZF, adds some useful information to selected nodes (like jump hosts, `sudo -i` command, etc...), and returns JSON dictionary that could be used by other programs. CloudSelect is a team player in a shell environment. We can automatically open multiple interactive SSH sessions and provide passwords to `sudo -i` under TMUX environment.
+
+## Demo
+
+[![demo](https://raw.githubusercontent.com/ezh/cloudselect/master/docs/demo/2019-12-11_23-04-56%20cloudselect%20demo.gif)](https://github.com/ezh/cloudselect/tree/master/docs/demo)
+
+The tool is:
+1. connecting to bastion host with public IP 54.171.154.230
+2. using locally stored key on bastion because the usage of ssh-agent is restricted by security team ?lol? and sshd settings are `AllowTcpForwarding no`, `GatewayPorts no`
+3. jumping to 4 EC2 web instances in development environment that located in private subnet 172.30.x.x
+4. running `sudo -i` at startup
+5. entering `sudo` password 12345678
+
+*And after that, we have four ready to use interactive sessions in our terminal...*
+
+## Basic usage
+
+-   Connect to a single known_hosts server
+-   Connect to a single EC2 AWS instance
+
+## Advanced usage
+
+-   Connect to multiple known_hosts servers, run `sudo -i` command at startup and enter `sudo` password
+-   Connect to multiple EC2 AWS instances, run `sudo -i` command at startup and enter `sudo` password
+-   Connect to multiple EC2 AWS instances through a *bastion* host, run `sudo -i` command at startup and enter `sudo` password
+
+## Features
+
+:rocket: We may use jump hosts even if jump host hasn't been configured to allow remote port forwarding and we have the following settings in sshd_config:
+
+        AllowTcpForwarding no
+        GatewayPorts no
+
+## Installation
+
+CloudSelect is on PyPi! You can install CloudSelect with a simple pip command:
+
+        pip install cloudselect
+
+Add profile bash completion:
+
+         complete -C cloudselect_completer cloudselect
+
+You may copy suitable wrapper from `example` directory.
+
+# License
+
+[MIT][mit] © [Alexey Aksenov][author] et [al][contributors]
+
+[mit]: https://opensource.org/licenses/MIT
+
+[author]: https://github.com/ezh
+
+[contributors]: https://github.com/ezh/cloudselect/graphs/contributors

mkdocs.yml

@@ -0,0 +1 @@
+site_name: CloudSelect

requirements.dev.txt

@@ -1,4 +1,6 @@
 flake8==3.7.9
+mkdocs==1.0.4
+pre-commit==1.20.0
 ptpdb==0.17
 pylint==2.4.4
 pyls==0.1.6