Skip to content
New issue

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

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

Already on GitHub? # to your account

Update README.md #304

Merged
merged 2 commits into from
Feb 7, 2020
Merged

Update README.md #304

merged 2 commits into from
Feb 7, 2020

Conversation

ioMatrix
Copy link
Contributor

@ioMatrix ioMatrix commented Feb 2, 2020

No description provided.

@jonathansamines
Copy link
Collaborator

@ioMatrix Thanks for the contribution. However, I wonder if the same comprehension can be achieved by reading the API documentation? Would that helped in your case?

Originally, this documentation was all on the README file, but moved it as I wanted to further document all options and found the resulting documentation pretty dense for a README file. What do you think?

@ioMatrix
Copy link
Contributor Author

ioMatrix commented Feb 4, 2020

Absolutely, that is a great document!! However, I did not run into that file while parsing the readme. I wish I had... would of saved a lot of time. Perhaps it could be linked under the first usage example to be a bit more visible for the TL:DR crowd :)?

@jonathansamines
Copy link
Collaborator

@ioMatrix Thanks for the reply, it is actually linked in the README file, but almost at the end of the document. Would you mind moving it just below the first usage section?

@ioMatrix
Copy link
Contributor Author

ioMatrix commented Feb 4, 2020

Ready

@jonathansamines
Copy link
Collaborator

@ioMatrix Thanks for the contribution

@jonathansamines jonathansamines merged commit 8e689a9 into lelylan:master Feb 7, 2020
@ioMatrix ioMatrix deleted the patch-1 branch February 7, 2020 18:09
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants