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

[Documentation] Provide an overview as table in the README #3180

Open
rubyFeedback opened this issue Jan 18, 2025 · 1 comment
Open

[Documentation] Provide an overview as table in the README #3180

rubyFeedback opened this issue Jan 18, 2025 · 1 comment
Labels
documentation feature-request New feature or request

Comments

@rubyFeedback
Copy link

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 rubyFeedback added the feature-request New feature or request label Jan 18, 2025
@keith-hall
Copy link
Collaborator

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 🙂

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation feature-request New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants