I actually don’t think like that. I even have another fairly successful open source project whose readme is probably more to your liking, and is nothing like this one: https://github.com/cube2222/octosql
Everybody has different taste. I like README’s like that as they add an entertainment value. Overall I’ve got two kinds of feedback about the README:
1. I really like the project and really liked the readme, great fun to read!
2. The readme was very confusing on top of the already confusing query language.
And based on that I'm planning to keep it unchanged for now. I added the type cheatsheet to make case 2 at least a little bit better.
As for the quick examples, you can just scroll through the code blocks (as each one contains input with its corresponding output).
Since you're discarding feedback kind #2, and all of the potential users it represents, in favor of entertainment value, I'd say that you do think like that. ;) Comedians write lots of jokes, but when they stand up and tell them in front of an audience, they find out which ones work and which ones don't. How they respond to that feedback determines their success. Hey, it's your project.
I'm definitely not discarding it! I'm open to writing additional clarifying paragraphs. (that's why I wrote the type cheat sheet). I'm also not discarding feedback kind #1 :)
I'm thinking of adding another one which shows how standard map/filter notation maps to jql queries.
Anyways, thanks for the feedback again, I do appreciate it!
Everybody has different taste. I like README’s like that as they add an entertainment value. Overall I’ve got two kinds of feedback about the README: 1. I really like the project and really liked the readme, great fun to read! 2. The readme was very confusing on top of the already confusing query language.
And based on that I'm planning to keep it unchanged for now. I added the type cheatsheet to make case 2 at least a little bit better.
As for the quick examples, you can just scroll through the code blocks (as each one contains input with its corresponding output).