README: update text - Githubissues

FloeDesignTechnologies / phpcs-security-audit

phpcs-security-audit is a set of PHP_CodeSniffer rules that finds vulnerabilities and weaknesses related to security in PHP code

GNU General Public License v3.0

712 stars 85 forks source link

README: update text #63

Closed jrfnl closed 4 years ago

jrfnl commented 4 years ago

Add some badges.
Improve some of the grammar of various texts.
Improve use of markdown.
Let the default suggested way of running the tooling be with --standard=Security instead of pointing to a specific example ruleset.
Update the example output.

jrfnl commented 4 years ago

@jmarcil I've reverted the example commands for now as discussed above

This includes reverting (updating) the example output to be in line with the actual command in the readme.

The other changes related to the rulesets discussed above will/should be addressed in separate PRs.

P.S.: I rebased the PR to see the Travis build being triggered, but it appears to not be turned on correctly yet. Let me know if you need help getting it working.

jmarcil commented 4 years ago

Thanks!

I actually never activated it on Travis-CI.. working on it right now.

jrfnl commented 4 years ago

@jmarcil Should be a case of just toggling the switch for the repo. Let me know if you need help/screencast on how to do it.

jmarcil commented 4 years ago

Should be 😄

I don't know why, but I couldn't see FloeDesignTechnologies in my organizations (yet I can see another one), but I could still browse https://travis-ci.org/github/FloeDesignTechnologies and activate the repo from there.

Build is working as far as I can tell: https://travis-ci.org/github/FloeDesignTechnologies/phpcs-security-audit

jrfnl commented 4 years ago

@jmarcil Excellent! Glad you got it working. Will be helpful for adding the rest of the checks proposed in #56 and making sure the automated tests are all running & passing.