Scoutsuite: Improve README sexyness

Created on 27 Mar 2020  路  8Comments  路  Source: nccgroup/ScoutSuite

Would be good to make the landing page more attractive. The main improvement I'd see is an embedded GIF that displays running a job and viewing a report.

Add README to tools folder.

enhancement
Source
picture x4v13r64

All 8 comments

Happy to get a GIF together:

  1. Record the terminal running a job
  2. Navigate the report
    2a. Go into a service
    2b. Expand the description for a finding
    2c. Got into a finding and show details

Any other features you'd want expressed?

ramimac picture ramimac on 29 Mar 2020

I'd also recommend adding the PyPI download badge https://img.shields.io/pypi/dm/scoutsuite

ramimac picture ramimac on 29 Mar 2020
👍1

Threw together quick terminal gifs, one for installation (from pip) and one for running scoutsuite on aws

asciinema -> ttygif -> gifsicle (for improving the delay, cutting a couple long frames)

scoutsuite_installation
scoutsuite_running

ramimac picture ramimac on 29 Mar 2020
❤1

And a quick screencast, using https://ramimac.github.io/sadcloud-reports/scoutsuite-reports/scoutsuite-report_03_2020/aws.html

screencast

ramimac picture ramimac on 29 Mar 2020
❤1

Brilliant @ramimac, will include all of the above in the README / wiki.

For the sadcloud screencast I'll include a ref to the project.

x4v13r64 picture x4v13r64 on 31 Mar 2020

Closing as all the above is done.

@ramimac is it possible to make the CLI gifs a bit shorter (cut the vertical space a bit)?

x4v13r64 picture x4v13r64 on 3 Apr 2020

small_scout_install
small_scout_use_delayed

ramimac picture ramimac on 3 Apr 2020

Cheers @ramimac, updated both gifs.

x4v13r64 picture x4v13r64 on 4 Apr 2020
Was this page helpful?
0 / 5 - 0 ratings

Related issues

dataatsky picture dataatsky  路  7Comments
thommor picture thommor  路  4Comments
Aboisier picture Aboisier  路  8Comments
heydonovan picture heydonovan  路  7Comments
thommor picture thommor  路  6Comments