Skip to content
This repository has been archived by the owner on Dec 29, 2017. It is now read-only.

Auto-generate README.mds from source files #8

Open
JoshuaKGoldberg opened this issue Oct 11, 2015 · 0 comments
Open

Auto-generate README.mds from source files #8

JoshuaKGoldberg opened this issue Oct 11, 2015 · 0 comments

Comments

@JoshuaKGoldberg
Copy link
Member

Requires #7.

README files should contain something like:

  • Name - Taken from package.json name
  • Short description - Taken from package.json description
  • Paragraph(s) description - Taken from {RepoName}.ts
  • Examples of usage - Taken from class {RepoName}'s JSDoc examples
  • Examples for each public function - Taken from each public function's JSDoc examples
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

1 participant