search

jarun / googler

:mag: Google from the terminal
GNU General Public License v3.0
6.11k stars 529 forks source link

Pulling examples to the top of README? #336

Closed zmwangx closed 4 years ago

zmwangx commented 4 years ago

Today’s issue #335 got me thinking, the README is huge right now, and whenever I see an overwhelming README that’s almost like Bash Reference Manual on one single HTML page, I want to see examples. The demo screencast is a start but not everyone is into watching “videos”.

What about pulling the examples section up? I’m thinking between the intro and the TOC (so it becomes a TOC for detailed, technical documentation).

Could also use an example showcasing search phrases being split into arbitrary command line arguments.

jarun commented 4 years ago

That would be a great improvement. From some past issues it looks like people are missing it.