docs: update readme

girorme · Feb 5, 2025 · 4273725 · 4273725
1 parent 559d141
commit 4273725
Show file tree

Hide file tree

Showing 2 changed files with 76 additions and 67 deletions.
diff --git a/README.md b/README.md
@@ -2,104 +2,113 @@
 [![Coverage Status](https://coveralls.io/repos/github/girorme/binoculo/badge.svg?branch=main)](https://coveralls.io/github/girorme/binoculo?branch=main)
 [![License](https://img.shields.io/badge/License-MIT-blue)](https://github.com/girorme/binoculo-daemon/blob/main/LICENSE)
 
-![usage](repo_assets/logo.png)
+![logo](repo_assets/logo.png)
 
+# Binoculo
+A lightning-fast banner grabbing tool built with **Elixir**, designed to quickly retrieve service banners from target hosts. Ideal for network reconnaissance and analysis, Binoculo efficiently collects service info across multiple ports.
 
-Binoculo is a lightning-fast banner grabbing tool built with Elixir, designed to swiftly retrieve service banners from target hosts. With its high-speed functionality, Binoculo efficiently collects service information across multiple ports, aiding in network reconnaissance and analysis.
+![usage](repo_assets/binoculo_usage.gif)
 
-![binoculo](https://github.com/user-attachments/assets/13d7d90b-0c63-4943-9490-44c381e56e99)
+---
 
+### :rocket: Features
+- **Fast Network Scanning**: Leverage Elixir's concurrent processing for rapid scans across multiple hosts and ports.
+- **Search Engine Integration**: Integrate with Meilisearch to index and query scan results for efficient data retrieval.
+- **Specific Banner Searches**: Perform targeted searches for specific service banners or versions.
+- **HTTP Write**: Send custom commands over HTTP to communicate with services and perform actions.
 
-## Requirements
+### :cog: Requirements
 - Docker
-- Optional: Elixir to run via your host machine
-
-## Features
-Fast Network Scanning
-> Utilize the enhanced multi-process task functionality in Binoculo for rapid network scans. Leverage concurrent processing to swiftly gather information across numerous hosts and ports, providing quick insights into your network's services.
+- Optional: Elixir installed locally
 
-Search engines Integration
-> Seamlessly integrate Binoculo with Meilisearch (current), enabling lightning-fast search capabilities over your scan results. Index and query your collected data with Meilisearch's powerful search engine, enabling efficient retrieval of network service information.
-
-Specific Banner Searches
-> Perform targeted searches for specific service banners. Refine your queries to focus on precise service types or versions, streamlining your network reconnaissance efforts.
+---
 
-HTTP Write
-> Send commands over HTTP to communicate with services and perform actions, enhancing your network exploration capabilities
+### Quick Start
+Run Binoculo easily with Docker with the `binoculo` shell script. Example:
 
-## Commands
+```bash
+$ ./binoculo -r 192.168.101.1/24 -p 21,22 --output my_result.txt
 ```
-Binoculo: You Know, for Banner Grabbing! Version: 1.2.1
-Author: Girorme <g1r0rm3@gmail.com>
-A banner grabbing tool
-
-USAGE:
-    Binoculo [-v] --range host_notation --port port(s) [--output output] [--write write] [--read read]
-    Binoculo --version
-    Binoculo --help
-
-FLAGS:
 
-    -v        Verbosity level                                                                                                
+Results will be saved in output/my_result.txt.
 
-OPTIONS:
+---
 
-    --range             CIDR or IP range: 192.168.1.0/24 or 192.168.1.0..192.168.1.255                                       
-    -p, --port          Port(s) to scan: 80,443,8080 or 80-8080 or 21,80-8080                                                
-    -o, --output        Output file                                                                                          
-    -w, --write         Write cutom payload to socket, e.g: GET / HTTP/1.1                                                   
-    -r, --read          Save only responses that match with this string, e.g: Apache                                                                                   
-```
+### Example Commands
+Basic Usage:
 
-## Usage
-There is a "binoculo" bash script that you can run:
+> In addition to saving the results with --output, you can use meilisearch/dashboard to store and visualize the results. ([meilisearch integration](#Meilisearch-Integration))
 
-- Start meilisearch container
-- Start front dashboard to filter and visualize results
-- Run binoculo via docker for ease of use
+```bash
+Binoculo: You Know, for Banner Grabbing! Version: 1.2.1
 
-**The command below runs via docker**
-```
-$ ./binoculo -r 192.168.101.1/24 -p 21,22 --output my_result.txt
+USAGE:
+    Binoculo --range <host_notation> --port <port(s)> [--output <file>] [--write <payload>] [--read <criteria>]
 ```
 
-Finishing the scan you can get the results via `output/my_result.txt` generated by the `--output` switch
-
-## More features
-- Write custom payload to socket (inspired by pnscan :bowtie:)
+Range of ports:
+```bash
+$ ./binoculo --range 192.168.101.1/24 --port 21,22,3301
+$ ./binoculo --range 192.168.101.1/24 --port 8080-8082,9000
 ```
+
+Write Custom Payload:
+```bash
 $ ./binoculo --range 192.168.101.1/24 -p 80 --output result.txt -w "GET / HTTP/1.1"
 ```
 
-- Save only matching criteria (inspired by pnscan :bowtie:)
-```
+Save Only Matching Criteria:
+```bash
 $ ./binoculo --range 192.168.101.1/24 -p 80 --output result.txt -w "HEAD / HTTP/1.1" -r "Apache"
 ```
 
-- Save only matching multiple criteria (AND operator) (inspired by pnscan :bowtie:)
-```
-$ ./binoculo --range 192.168.101.1/24 -p 80 --output result.txt -w "HEAD / HTTP/1.1" -r "Apache,php"
-```
+### Meilisearch Integration
 
-### Meilisearch integration ⭐
-```
-$ ./binoculo --meili
+```bash
+$ ./binoculo --dashboard
 ```
 
-The command above launches a meilisearch container!
+View results in your browser at `localhost:3000`
 
-_You can now access `localhost:7700` to get results via meilisearch_
+This command launches Meilisearch along with a dashboard where you can view your scan results. The results are displayed in a faceted manner, making it easier to search and filter through the collected data. Faceted search allows you to narrow down your results based on various categories, providing an efficient way to explore your network scans.
 
-**Meilisearch print**
-![image](https://github.com/girorme/binoculo/assets/54730507/8654ec1e-5562-41f5-928d-4e8033e139e6)
+![dashboard](repo_assets/dashboard.png)
 
----
+#### Using Meilisearch Endpoints
 
-## Update
-To update to the latest version use the command below:
+In addition to the dashboard, you can also interact with Meilisearch (`localhost:7700`) directly via its API endpoints to perform searches. The scan results are indexed under the `hosts` index, allowing you to make custom queries and retrieve data without needing to use the dashboard interface. This gives you the flexibility to integrate Binoculo with other systems or tools that can consume the Meilisearch API for advanced searching and filtering.
 
-> ./binoculo -u
+### Update Binoculo
 
----
-## Architecture
-![image](repo_assets/binoculo-arch.png)
+Keep Binoculo up to date:
+```bash
+$ ./binoculo -u
+```
+
+### Architecture
+![arch](repo_assets/binoculo-arch.png)
+
+This tool was inspired by the speed and simplicity of pnscan, but built with the power of Elixir to take banner grabbing to the next level!
+
+```
+MIT License
+
+Copyright (c) 2023 Girorme
+
+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 CONN
+```
diff --git a/repo_assets/dashboard.png b/repo_assets/dashboard.png