ember-cli-deploy-git icon indicating copy to clipboard operation
ember-cli-deploy-git copied to clipboard

Published 20 hours ago • verified publisher icon ef4

README format

Open lukemelia opened this issue 9 years ago • 1 comments

Thanks for contributing this plugin to the ecosystem! To make composing plugins as easy as possible, we're encouraging plugin authors to conform to a README format that includes some key sections that are missing from your README. You can see a thorough example of READMEs in the preferred format at https://github.com/ember-cli-deploy/ember-cli-deploy-redis and https://github.com/ember-cli-deploy/ember-cli-deploy-json-config.

In particular, it would be great to see your README gain the "ember-cli-deploy Hooks Implemented", "Prerequisites", and "Plugins known to work well with this one" sections.

lukemelia avatar Nov 24 '15 12:11 lukemelia

Awesome, glad to see such thought put into conventions.

ef4 avatar Nov 25 '15 18:11 ef4