Skip to content

Commit 2f99e31

Browse files
committed
chore: better README with a screenshot
1 parent 5808a22 commit 2f99e31

File tree

2 files changed

+21
-2
lines changed

2 files changed

+21
-2
lines changed

README.md

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,22 @@
1-
# TruffleShow
1+
<div align="center">
2+
<img src="./src/public/android-chrome-192x192.png" alt="TruffleShow Logo" width="100" height="100">
3+
<h1>TruffleShow</h1>
4+
</div>
25

3-
A simple web viewer for TruffleHog JSON output.
6+
A simple web viewer for TruffleHog JSON output.
7+
8+
**Completely client-side**. No data is sent to the server. Actually, there is no server.
9+
10+
- Get the JSON output* from TruffleHog
11+
- Upload it to TruffleShow.
12+
- View the results.
13+
14+
Note: TruffleHog produces [a broken JSON file](https://github.com/trufflesecurity/trufflehog/issues/2164). To get a valid JSON file, you can use `jq` like this:
15+
16+
```sh
17+
trufflehog git https://github.com/trufflesecurity/test_keys --json | jq -s . > trufflehog.json
18+
```
19+
20+
Screenshot:
21+
22+
![TruffleShow Screenshot](./ss.png)

ss.png

99.8 KB
Loading

0 commit comments

Comments
 (0)