Skip to content

Commit 167ad24

Browse files
committed
chore: update readme
1 parent 893cd02 commit 167ad24

File tree

1 file changed

+20
-2
lines changed

1 file changed

+20
-2
lines changed

README.md

+20-2
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@
33
<h1>TruffleShow</h1>
44
</div>
55

6-
A simple web viewer for TruffleHog JSON output.
6+
A simple web viewer for TruffleHog JSON output.
77

88
**Completely client-side**. No data is sent to the server. Actually, there is no server.
99

10-
- Get the JSON output* from TruffleHog
10+
- Get the JSON output from TruffleHog
1111
- Upload it to TruffleShow.
1212
- View the results.
1313

@@ -20,3 +20,21 @@ trufflehog git https://github.com/trufflesecurity/test_keys --json | jq -s . > t
2020
Screenshot:
2121

2222
![TruffleShow Screenshot](./ss.png)
23+
24+
## Roadmap
25+
26+
I am not sure if I will implement these features but here are some ideas:
27+
28+
- [ ] Complete the PDF report generation (currently it is very basic and incomplete)
29+
- [ ] Accept JSON file via text input
30+
- [ ] Generate and export ignore rules for TruffleHog by selecting items
31+
- [ ] Search among the findings
32+
- [ ] Add more TruffleHog sources (e.g. GitLab, Bitbucket, Docker, etc.)
33+
34+
## Feedback and Contributing
35+
36+
This is a very simple tool. I don't plan to add many features but I'm open to suggestions. Feel free to open an issue or send a pull request.
37+
38+
## License
39+
40+
MIT

0 commit comments

Comments
 (0)