search

SamuraiWTF / samuraiwtf

The main SamuraiWTF collaborative distro repo.
https://owasp.org/www-project-samuraiwtf/#SamuraiWTF_Project
GNU Lesser General Public License v3.0
462 stars 119 forks source link

Prettify #82

Closed elreydetoda closed 5 years ago

elreydetoda commented 5 years ago

So there are a few things with this pull request.

  1. I swapped out the h1 header for a picture with the logo that I found in drive and put up on tiny.si
  2. I added a lot of badges, just to kind of give some more up front info about the repo as soon as someone visits it.
    • slack link for the samuraiwtf channel
    • amount of Github Downloads that github has tracked (since this is so low I figured we probably shouldn't use this one but I just wanted to show that it is possible to show
    • how many downloads we had over at Source Forge, but I prepend that it is deprecated and if you click on it then it brings you back to the github repo. This had a lot more downloads, so it looks good for the repo :smile:
    • what the current release is
    • the license that is on repo
    • twitter pre-formatting for sharing, so people can let others know about their experience easier (which has the following included in it)

    • SamuraiWTF

    • ProfessionallyEvil

    • url to the samurai.wtf website (which isn't currently working, but my plan is to have that url point to the github repo till we get a site up and running)
    • tagging @secureideas (our company, not kevin like how github thinks)
    • link to follow the company twitter account for updates

Note: so far everything that I have listed so far was done in html to get better formatting control.

  1. Explicitly stated that people can message us in the proevil chat samuraiwtf channel, in case they don't know they can click the button.
  2. linked to the section talking about contributing
  3. moved the instructions for how to install through ova down to install section, but linked to if they want to get started quick
  4. added link to LMS for understanding this process a little better.