Generate useful repo README file

michaeljguarino commented 1 year ago

Summary

This could potentially help onboard users quicker to understanding their repo. Refactored to just pull from our docs github so we can easily iterate on it as well.

Test Plan

executed plural readme to confirm it generates appropriately

Checklist

[ ] If required, I have updated the Plural documentation accordingly.
[ ] I have added tests to cover my changes.
[ ] I have added a meaningful title and summary to convey the impact of this PR to a user.
[ ] I have added relevant labels to this PR to help with categorization for release notes.

davidspek commented 1 year ago

What happens if the file already exists?

michaeljguarino commented 1 year ago

It would just overwrite it currently, but the only paths it executes currently is init and shell setup, so really shouldn't overwrite ever

pluralsh / plural-cli