add ci integration example to readme

orium / cargo-rdme

Cargo command to create the README.md from your crate's documentation

Mozilla Public License 2.0

126 stars 5 forks source link

add ci integration example to readme #141

Closed orhanbalci closed 1 year ago

orhanbalci commented 1 year ago

Hi there; I was a cargo-sync-readme user but that project seems to be abandoned. Migrating my projects to cargo-rdme. It would be nice to have a github ci integration example on readme. I want to be able to have a PR if another PR have changes that updates README.

orium commented 1 year ago

Hi.

I want to be able to have a PR if another PR have changes that updates README.

I'm not sure how easy that is, but I think it is a better idea to just fail CI of the original PR if it doesn't update the README. I've added an example of github actions to the README.