Add logo (#51)

v-byte-cpu · web-flow · commit ad560fe9582a · 2021-04-19T15:34:55.000+03:00
diff --git a/README.md b/README.md
@@ -1,26 +1,46 @@
-# sx
 
+<h1 align="center">
+<img alt="sx" width="400" src="assets/logo.svg">
+</h1>
+
+<div align="center">
+
+[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/v-byte-cpu/sx/blob/master/LICENSE)
 [![Build Status](https://cloud.drone.io/api/badges/v-byte-cpu/sx/status.svg)](https://cloud.drone.io/v-byte-cpu/sx)
 [![GoReportCard Status](https://goreportcard.com/badge/github.com/v-byte-cpu/sx)](https://goreportcard.com/report/github.com/v-byte-cpu/sx)
 
+</div>
+
 **sx** is the command-line network scanner designed to follow the UNIX philosophy.
 
 The goal of this project is to create the fastest network scanner with clean and simple code.
 
-## Features
+## 📖 Table of Contents
+
+* [Features](https://github.com/v-byte-cpu/sx#features)
+* [Build from source](https://github.com/v-byte-cpu/sx#build-from-source)
+* [Quick Start](https://github.com/v-byte-cpu/sx#build-from-source)
+* [References](https://github.com/v-byte-cpu/sx#references)
+* [Contributing](https://github.com/v-byte-cpu/sx#contributing)
+* [Credits](https://github.com/v-byte-cpu/sx#credits)
+* [License](https://github.com/v-byte-cpu/sx#license)
+
+## ✨ Features
 
+  * **⚡ 30x times faster** than nmap
   * **ARP scan**: Scan your local networks to detect live devices
   * **ICMP scan**: Use advanced ICMP scanning techniques to detect live hosts and firewall rules
   * **TCP SYN scan**: Traditional half-open scan to find open TCP ports
   * **TCP FIN / NULL / Xmas scans**: Scan techniques to bypass some firewall rules
   * **Custom TCP scans with any TCP flags**: Send whatever exotic packets you want and get a result with all the TCP flags set in the reply packet
   * **UDP scan**: Scan UDP ports and get full ICMP replies to detect open ports or firewall rules
-  * **SOCKS5 scan**: Detect live SOCKS5 proxies by scanning ip range or list of ip/port pairs from a file
-  * **Docker scan**: Detect open Docker daemons listening on TCP ports and get information about the docker node
-  * **Elasticsearch scan**: Detect open Elasticsearch nodes and pull out cluster information with all index names
+  * **Application scans**:
+    * **SOCKS5 scan**: Detect live SOCKS5 proxies by scanning ip range or list of ip/port pairs from a file
+    * **Docker scan**: Detect open Docker daemons listening on TCP ports and get information about the docker node
+    * **Elasticsearch scan**: Detect open Elasticsearch nodes and pull out cluster information with all index names
   * **JSON output support**: sx is designed specifically for convenient automatic processing of results
 
-## Build from source
+## 🛠 Build from source
 
 Requirements:
 
@@ -33,7 +53,7 @@ From the root of the source tree, run:
 go build
 ```
 
-## Quick Start
+## 🚀 Quick Start
 
 Here's a quick examples showing how you can scan networks with `sx`.
 
@@ -389,7 +409,7 @@ In this case only ip addresses will be taken from the file and the **port** fiel
 ./sx help
 ```
 
-## Reference
+## 📜 References
 
   * **Network Security Assessment: Know Your Network 1st Edition** by Chris McNab
   * **ICMP Usage in Scanning - The Complete Know-How** by Ofir Arkin
@@ -399,6 +419,14 @@ In this case only ip addresses will be taken from the file and the **port** fiel
   * [SOCKS Protocol Version 5 ( rfc1928 )](https://tools.ietf.org/rfc/rfc1928.txt)
   * [Internet Control Message Protocol ( rfc792 )](https://tools.ietf.org/rfc/rfc792.txt)
 
+## 🤝 Contributing
+
+Contributions, issues and feature requests are welcome.
+
+## 💎 Credits
+
+Logo is designed by [mikhailtsoy.com](https://mikhailtsoy.com/)
+
 
 ## License
 
diff --git a/assets/logo.svg b/assets/logo.svg
@@ -0,0 +1 @@
+<svg id="Layer_1" data-name="Layer 1" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 206.66 80.03"><defs><style>.cls-1{fill:#1b98e0;}.cls-2{fill:none;}</style></defs><path class="cls-1" d="M104.16,66.29a8.79,8.79,0,0,1-6.46-2.66A8.9,8.9,0,0,1,95,57.1V54.54H102v2a2.78,2.78,0,0,0,.7,2.12,2.9,2.9,0,0,0,2.08.66h33.07a2.78,2.78,0,0,0,2-.66,2.89,2.89,0,0,0,.66-2.12V46.22a2.36,2.36,0,0,0-2.7-2.7H104.16a8.75,8.75,0,0,1-6.46-2.7A8.85,8.85,0,0,1,95,34.39V22.93A8.9,8.9,0,0,1,97.7,16.4a8.79,8.79,0,0,1,6.46-2.66H138.4a9.15,9.15,0,0,1,9.2,9.19v2.56h-7.08v-2a2.89,2.89,0,0,0-.66-2.12,2.78,2.78,0,0,0-2-.66H104.75a2.9,2.9,0,0,0-2.08.66,2.78,2.78,0,0,0-.7,2.12V33.81a2.64,2.64,0,0,0,.7,2,2.9,2.9,0,0,0,2.08.66H138.4a8.87,8.87,0,0,1,6.5,2.7,8.77,8.77,0,0,1,2.7,6.43V57.1a9.15,9.15,0,0,1-9.2,9.19Z"/><path class="cls-1" d="M154.68,66.29v-.8L176.07,40,154.68,14.54v-.8h8.39l17.6,20.8,17.52-20.8h8.39v.8L185.19,40l21.47,25.41v.87h-8.47l-17.52-20.8-17.6,20.8Z"/><circle class="cls-1" cx="15.02" cy="68.39" r="2.51"/><circle class="cls-1" cx="40.01" cy="40.02" r="4.75"/><path class="cls-1" d="M40,47A6.95,6.95,0,1,1,47,40,7,7,0,0,1,40,47Zm0-9.51A2.57,2.57,0,1,0,42.58,40,2.57,2.57,0,0,0,40,37.45Z"/><path class="cls-1" d="M53.06,29.52a16.65,16.65,0,0,0-10.52-6.05l.66-4.33a21.07,21.07,0,0,1,13.27,7.64Z"/><circle class="cls-1" cx="40.01" cy="11.64" r="2.51"/><circle class="cls-1" cx="70.66" cy="17.83" r="2.51"/><circle class="cls-1" cx="31.75" cy="57.05" r="2.51"/><path class="cls-2" d="M31.75,54.54h0a16.1,16.1,0,0,0,2,1A2.51,2.51,0,0,0,31.75,54.54Z"/><path class="cls-2" d="M31.75,59.57l.25,0a20.2,20.2,0,0,1-2.38-1.17A2.49,2.49,0,0,0,31.75,59.57Z"/><path class="cls-1" d="M27.17,50.73A16.63,16.63,0,0,1,23.28,40a16.82,16.82,0,0,1,7-13.59l-2.56-3.55a21.07,21.07,0,0,0-3.21,31.37A7.88,7.88,0,0,1,27.17,50.73Z"/><path class="cls-1" d="M29.23,57.05a2.46,2.46,0,0,0,.39,1.32A20.2,20.2,0,0,0,32,59.54a2.49,2.49,0,0,0,1.73-4,16.1,16.1,0,0,1-2-1A2.52,2.52,0,0,0,29.23,57.05Z"/><path class="cls-1" d="M56.75,40A16.74,16.74,0,0,1,40,56.75l-.46,0c0,.11,0,.21,0,.32a7.78,7.78,0,0,1-1.11,4c.52,0,1,.08,1.56.08A21.14,21.14,0,0,0,61.13,40Z"/><circle class="cls-1" cx="31.75" cy="57.05" r="2.51"/><path class="cls-2" d="M15.62,66c.57.53,1.15,1.06,1.75,1.55A2.48,2.48,0,0,0,15.62,66Z"/><path class="cls-2" d="M14.55,70.86c-.66-.54-1.29-1.11-1.91-1.7A2.49,2.49,0,0,0,14.55,70.86Z"/><path class="cls-2" d="M69.54,20.07c-.43-.64-.88-1.26-1.36-1.87A2.52,2.52,0,0,0,69.54,20.07Z"/><path class="cls-2" d="M71.64,15.51c.53.68,1,1.38,1.51,2.09A2.52,2.52,0,0,0,71.64,15.51Z"/><path class="cls-1" d="M67.32,10.78a40.21,40.21,0,0,0-8.23-5.95L57,8.68a35.2,35.2,0,0,1,7,5A7.77,7.77,0,0,1,67.32,10.78Z"/><path class="cls-1" d="M76.31,23.21a7.72,7.72,0,0,1-3.8,2.2A35.61,35.61,0,0,1,22.39,71a7.87,7.87,0,0,1-2.56,3.57A40,40,0,0,0,76.31,23.21Z"/><path class="cls-1" d="M11.53,61.41a35.62,35.62,0,0,1,.78-43.81l-3.4-2.76A40,40,0,0,0,8.32,64.4,7.84,7.84,0,0,1,11.53,61.41Z"/><path class="cls-1" d="M15,65.88a2.51,2.51,0,0,0-2.51,2.51,2.44,2.44,0,0,0,.13.77c.62.59,1.25,1.16,1.91,1.7a2.42,2.42,0,0,0,.47,0,2.52,2.52,0,0,0,2.52-2.52,2.6,2.6,0,0,0-.17-.88c-.6-.49-1.18-1-1.75-1.55A2.41,2.41,0,0,0,15,65.88Z"/><path class="cls-1" d="M69.54,20.07a2.51,2.51,0,0,0,3.64-2.24,1.81,1.81,0,0,0,0-.23c-.48-.71-1-1.41-1.51-2.09a2.63,2.63,0,0,0-1-.19,2.51,2.51,0,0,0-2.51,2.51c0,.13,0,.25,0,.37C68.66,18.81,69.11,19.43,69.54,20.07Z"/><circle class="cls-1" cx="70.66" cy="17.83" r="2.51"/><path class="cls-1" d="M57,8.68a35.61,35.61,0,0,0-17-4.3,35,35,0,0,0-5.42.41,34.64,34.64,0,0,0-5.71,1.36L27.51,2A40.16,40.16,0,0,1,59.09,4.83Z"/><circle class="cls-1" cx="40.01" cy="11.64" r="2.51"/><path class="cls-2" d="M38.85,13.86a2.49,2.49,0,0,0,2.33,0l-1.17,0C39.62,13.83,39.24,13.84,38.85,13.86Z"/><path class="cls-2" d="M38.74,9.48c.42,0,.85,0,1.27,0s.86,0,1.28,0A2.54,2.54,0,0,0,40,9.12,2.5,2.5,0,0,0,38.74,9.48Z"/><path class="cls-1" d="M32.3,10.44A30.57,30.57,0,1,0,50.17,68.85l-1.46-4.12A26.19,26.19,0,1,1,32.88,14.82a7.63,7.63,0,0,1-.58-4.38Z"/><path class="cls-1" d="M38.74,9.48a2.5,2.5,0,0,0,.11,4.38c.39,0,.77,0,1.16,0l1.17,0a2.5,2.5,0,0,0,.11-4.38c-.42,0-.85,0-1.28,0S39.16,9.46,38.74,9.48Z"/><path class="cls-1" d="M47.73,10.44a7.88,7.88,0,0,1,.1,1.2,7.69,7.69,0,0,1-.69,3.18A26.19,26.19,0,0,1,58.42,58.65l3.08,3.11A30.57,30.57,0,0,0,47.73,10.44Z"/></svg>
