Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

README Doc #1

Closed
MattIPv4 opened this issue Jul 6, 2019 · 1 comment
Closed

README Doc #1

MattIPv4 opened this issue Jul 6, 2019 · 1 comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers

Comments

@MattIPv4
Copy link
Member

MattIPv4 commented Jul 6, 2019

Whilst every method in the script has a correct JSDoc descriptor attached, this should really have an overall README which describes the three index.js flags and what they do, alongside covering the config JSON file.
@MattIPv4 MattIPv4 added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers labels Jul 6, 2019
@MattIPv4 MattIPv4 mentioned this issue Jul 6, 2019
Closed
@MattIPv4
Copy link
Member Author

bb56edb

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@MattIPv4