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

Refactor Readme #7

Open
stsdc opened this issue May 2, 2020 · 2 comments
Open

Refactor Readme #7

stsdc opened this issue May 2, 2020 · 2 comments

Comments

@stsdc
Copy link
Contributor

stsdc commented May 2, 2020

First of all: this tool is amazing! Thank You!
But the readme file is huge, it is hard to find how to do basic things.
IMHO: Readme should be decluttered and must include most basic things, other specific options and functions should be on gitbook or wiki.

If You're ok with this, I'll try to make a PR.
Thanks again for this utility and please continue <3
@Carglglz
Copy link
Owner

Carglglz commented May 2, 2020

But the readme file is huge, it is hard to find how to do basic things.

Yes, I'm aware.

The README just kept on growing as the project did, but now I do belive a refactor is necessary, as well as some sort of "wiki" or the "read the docs". I made a gitbook so feel free to make contributions both in the README in this repo as well as in the gitbook. 👍

@stsdc
Copy link
Contributor Author

stsdc commented May 3, 2020

PR #12 is ready for review and merge.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@stsdc @Carglglz