Update README

[baxterjo]

Since this action is pointed to as the official way to run cargo-audit in GHA CI. I think the docs need a little love.

Updated readme to be more consistent with popular github actions' docs . Specifically templating off of the checkout action readme.

[tarcieri]

Since this action is pointed to

I'm not seeing where it's mentioned, but really this thing is barely on life support. I am a maintainer of last resort and lack the relevant expertise to even keep this project going.

People should probably switch to cargo-deny-action which is well-maintained.

[baxterjo]

Whoops, that was a bad link. Here is the correct one.

https://github.com/RustSec/rustsec/tree/main/cargo-audit#using-cargo-audit-on-github-action

[baxterjo]

but really this thing is barely on life support.

@tarcieri is "this thing" all of cargo-audit or just the github action?

[tarcieri]

this particular repo, i.e. the GitHub Action

If we do something other than steering people to cargo-deny, it should probably be to just replace it with something massively simpler that installs and runs cargo audit for you using just declarative configuration without any JavaScript involved

[baxterjo]

Yea I'd be hesitant to redirect people to deny from here because it is an entire framework / tool shift rather than a simple drop in replacement. But that is up to you guys.