Add Usage Section in README.md

IEEE-VIT / termiboard

A smart CLI Dashboard to fetch cpu, memory and network stats!

MIT License

35 stars 16 forks source link

Add Usage Section in README.md #25

Closed sjchoure closed 3 years ago

sjchoure commented 3 years ago

Fixes #24

[x] Added Usage Section for providing information on Flag usage.

sjchoure commented 3 years ago

I think this README update can be done after the basic functions have been fully implemented.

Okay, saving the PR as Draft

DarthBenro008 commented 3 years ago

@saviourcode could you rebase the readme and make the changes mentioned before?

sjchoure commented 3 years ago

@DarthBenro008 Yes sure.

sjchoure commented 3 years ago

@DarthBenro008 @aryan9600 I have made the desired changes to the README.md file, link to preview: here

sjchoure commented 3 years ago

@DarthBenro008 I am adding badges

sjchoure commented 3 years ago

Badges @DarthBenro008 Are they covering our project properly?

DarthBenro008 commented 3 years ago

Open Source , license , go version, build status from termiboard-build CI, open issues, PRs welcome. These badges would be enough and please maintain consistent badge styles , the PRs welcome badge has a different styling than others

sjchoure commented 3 years ago

badgesnew