bat icon indicating copy to clipboard operation
bat copied to clipboard

[Documentation] Provide an overview as table in the README

Open rubyFeedback opened this issue 11 months ago • 1 comments

Hey guys,

I found bat here through kojix2.

It has a lot of documentation in the README which is good.

But, after reading it a little, I am still not sure why I would want or need bat.

Could you guys add a table as overview listing the most important features? Like 10 points or so. Does not have to be too long, but it should mention the "why would you want this". That way we can quickly check "is this what we need". Right now I have a lot of things to read but I was not prepared for that as I just followed what kojix2 is doing really. :)

rubyFeedback avatar Jan 18 '25 13:01 rubyFeedback

Respectfully, I feel the readme's Key Features are pretty prominent, with the headings and short descriptions showing what bat does above and beyond standard cat:

  • syntax highlighting
  • git integration
  • automatic paging
  • show non-printable characters

If you really feel a table would be clearer, feel free to open a PR so we can review and make an objective decision 🙂

keith-hall avatar Jan 18 '25 13:01 keith-hall