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.

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

Extend README with examples of usage #18

Open
tomVeloso opened this issue Nov 20, 2017 · 3 comments
Open

Extend README with examples of usage #18

tomVeloso opened this issue Nov 20, 2017 · 3 comments

Comments

@tomVeloso
Copy link

tomVeloso commented Nov 20, 2017

The project seam very interesting, would be nice to help people to more easly try it to add some lines on the readme with some simple examples of usage that underline the main features of the package.

@tomVeloso tomVeloso changed the title Extend Readme Extend README with examples of usage Nov 20, 2017
@pkgw
Copy link
Owner

pkgw commented Nov 21, 2017

Thanks for your interest! Yes, the README should be better. I'm quite busy these days so it will likely take me a while to get to this one, but I did want to acknowledge it.

@tomVeloso
Copy link
Author

Great! ... In the meanwhile, do you have any simple command line example to share with me? I'd love to start to try it ..

@cefect
Copy link

cefect commented Nov 20, 2024

agreed. I can't find any documentation or an example of how to run it. spending 30 seconds to add an example CLI call would make the tool usable.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants