Shivansh-007 / piston-cli

Universal shell supporting code highlighting, files, and interpretation without the need to download a language.
https://shivansh-007.github.io/piston-cli/
MIT License
45 stars 16 forks source link

Flesh out the readme #60

Closed Shivansh-007 closed 3 years ago

Shivansh-007 commented 3 years ago

It should probably have collapsible sections, maybe a table of contents, and screenshots of showcasing piston-cli

fmgoliveira commented 3 years ago

Hey, maybe I can do it... Pls send me only all the features and the content you want in the documentation. And the screenshots... Thx!

Shivansh-007 commented 3 years ago

Hey @franciscomgoliveira thank you for showing interest in this.

I don't think there is a need to for someone to do the features/content of the documentation when I am sending everything, I could basically do that myself. Sorry if I am getting rude, don't know how else I can say it. I can provide the screenshots but the content itself should be done by the person who is assigned to this.

Content wise, here is a rough idea:

fmgoliveira commented 3 years ago

Hey @Shivansh-007 I did ask for the content only because I never used piston cli so I don't know exactly how it works. No problem, you were not rude 😉.

Shivansh-007 commented 3 years ago

Hey @Shivansh-007 I did ask for the content only because I never used piston cli so I don't know exactly how it works. No problem, you were not rude wink.

Oh sure! After thinking about this, I think it would be better if this issue is left to the maintainers, since they are best familiar with the library and would be able to make the content most easily. You can checkout the other issues and comment if you are interested in them.

Thankyou, have a great day!