Skip to content

Commit 010a32d

Browse files
committed
Update README.md for improved formatting and clarity
1 parent 6cfddd1 commit 010a32d

1 file changed

Lines changed: 15 additions & 6 deletions

File tree

README.md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
[![Lint Python](https://github.com/atao/Shodan2DB/actions/workflows/main.yml/badge.svg)](https://github.com/atao/Shodan2DB/actions/workflows/main.yml)
2+
23
# Shodan2DB
4+
35
🔌 Shodan export to SQLite database and generate an HTML report.
46

57
## Purpose
@@ -14,13 +16,14 @@ Generate a report of found CVEs with HTML template.
1416
Customize the report in `templates/` folder using jinja2 and Bulma CSS.
1517

1618
## Requirements
17-
```
19+
20+
```bash
1821
pip install -r requirements.txt
1922
```
2023

2124
## Usage and options
2225

23-
```
26+
```bash
2427
Usage: shodan2db.py [OPTIONS] COMMAND [ARGS]...
2528

2629
Options:
@@ -30,8 +33,10 @@ Commands:
3033
export Generate an HTML report from the data in the database.
3134
parse Parse the Shodan JSON export file and store data in the database.
3235
```
36+
3337
- *Command parse*
34-
```
38+
39+
```bash
3540
Usage: shodan2db.py parse [OPTIONS]
3641

3742
Parse the Shodan JSON export file and store data in the database.
@@ -42,8 +47,10 @@ Options:
4247
-v, --verbose Verbose mode.
4348
-h, --help Show this message and exit.
4449
```
50+
4551
- *Command export*
46-
```
52+
53+
```bash
4754
Usage: shodan2db.py export [OPTIONS]
4855

4956
Generate an HTML report from the data in the database.
@@ -59,6 +66,7 @@ Options:
5966
```
6067

6168
## Quickstart
69+
6270
Do a search and click on "**Download Results**".
6371

6472
<img src="img/Shodan Export.png">
@@ -72,7 +80,8 @@ Download your results.
7280
<img src="img/Shodan Download.png">
7381

7482
Then import the results into the database using the command :
75-
```
83+
84+
```bash
7685
python .\shodan2db.py parse -i .\example_shodan.json -d .\example_database.db -v
7786
python .\shodan2db.py export -d .\example_database.db -d .\example_report.html -v
7887
```
@@ -99,4 +108,4 @@ Use Shodan2DB as python class
99108
import shodan2db as sh
100109

101110
sh.Shodan2DB.export(verbose=True, exportfile="test.html", database="test.db")
102-
```
111+
```

0 commit comments

Comments
 (0)