2nd sentence - Explaining the tool to folks in the general web domain what it can do for them.
3rd sentence - Explaining where to learn how to use the tool if you've stumbled across it but web is not your area of expertise.
All that info fits in nearly 25 words then it lists the options for the tool and jumps straight into multiple examples (with outputs!). If the only explanation had been "htmlq: like jq, but for HTML" I'd agree but having the comparison to explain what it does isn't a bad thing it's _only_ having the comparison that would be bad.
Personally I think this is a model example of a opening for a Github readme.
If you're going to write a minimal introduction, at least make sure it's not confusing.
I get the feeling the author felt compelled to write an introduction and did so with as little effort as possible.
0. https://www.google.com/search?hl=en&q=%22bits%20content%22
Honestly you could drop the "bits" which is a bit redundant and use the phrase "Uses CSS selectors to extract content from HTML files."
So for general purposes, it's a terrible marketing pitch. And yet I think it's a very, very valuable demonstration of knowing some of their 'customers'.
I'll be trying it out next time I'm on a PC.
I can, and it's not illuminating at all.
But if you haven't used Jq that I can see how that title is less than helpful.
You know Jimmy the famous mechanic? I'm Timmy, _his brother_ but an electrician.
IMO, at least `jq` has proven itself as the indispensable tool for json-data manipulation.
As a job, computers were largely automated out of existence by solid-state transistor based automated computers and integrated circuit transistor automated computers in the 60s, 70s and 80s, which replaced the enormously expensive and often largely experimental electro-mechanical automated computers while radically reducing cost and improving performance both by several orders of magnitude.
Possibly, depending on background as you note, but not all promotion is intended at the same audience. When submitting to HN, "like jq, but for X" is short and conveys what it is to most the people that would care, I think. jq has been submitted and talked about here many times with lively discussion over the years.[1] At this point I think most those that are interested in what that is and what this is will understand fairly quickly from the title. Those that don't might be missed, or they might look it up like you, or they might see it through some other submission some other time with a different title which isn't based on a chain of references.
1: https://hn.algolia.com/?dateRange=all&page=0&prefix=false&qu...
I would expect that htmlq run the query a single time for a single html; just like jquery $('#something') or document.querySelector('#something')
"jq is like sed for JSON data"
sed: "While in some ways similar to an editor which permits scripted edits (_such as ed_), sed works by making only one pass over the input(s)"
ed: "ed is a line-oriented text editor".
Software definition through a reference to another software is somewhat confusing. Potential users come from different backgrounds (I had no idea what is jq), and it is not clear what are the defining features of each project. Is jq line oriented? Is htmlq operating in a single pass?