Skip to content

Commit dad011d

Browse files
authored
Add screenshots in README (#21)
* Add screenshots in README
1 parent d0efc07 commit dad011d

4 files changed

Lines changed: 610 additions & 2 deletions

File tree

README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ Your ultimate IP dex!
99

1010
**ipdex** is a simple CLI tool to gather insight about a list of IPs or an IP using the [CrowdSec CTI](https://www.crowdsec.net/cyber-threat-intelligence) (Cyber Threat Intelligence) API.
1111

12+
<p align="center"> <img src="img/ipdex_single_ip.svg" alt="ipdex querying a single IP" width="600" /> </p>
13+
1214
---
1315

1416
## Table of Contents
@@ -149,13 +151,17 @@ Enter your API key and set your preferences.
149151
ipdex 1.2.3.4
150152
```
151153

154+
<p align="center"> <img src="img/ipdex_single_ip.svg" alt="ipdex querying a single IP" width="600" /> </p>
155+
152156
### 5. Scan a file
153157

154158
```bash
155-
ipdex file ips.txt
156-
ipdex file /var/log/nginx.log
159+
ipdex ips.txt
160+
ipdex /var/log/nginx.log
157161
```
158162

163+
<p align="center"> <img src="img/ipdex_file.svg" alt="ipdex scanning a file" width="900" /> </p>
164+
159165
---
160166

161167
## Configuration
@@ -258,6 +264,7 @@ By default, the `since` parameter is set to `30d`.
258264

259265
⚠️ Each queried page counts as 1 quota.
260266

267+
<p align="center"> <img src="img/ipdex_search.svg" alt="ipdex running a search query" width="600" /> </p>
261268

262269
#### Search IPs reported for a specific CVE
263270

0 commit comments

Comments
 (0)