README

[karoliskoncevicius]

README file is still missing. Should include all the operators and the rationale for each of them, as well as examples.

[moodymudskipper]

@KKPMW I've added a README, but I'm not very good at readmes :) . Can you take a look ?
I think the package should be pretty much done now, we should just make sure the doc of the functions is OK as I haven't looked at it for a long time.

[moodymudskipper]

de1e676

[karoliskoncevicius]

Thanks! Will look over the README and all other changes as well, and will see if I can add/improve anything. I am also not a good README writer (look at the READMEs for my packages here on github heh..) and on top of that - I have a mild fever currently. But want to contribute, so cloning the repo and looking over it now.

[karoliskoncevicius]

my suggested version in #24

[moodymudskipper]

Cool, I like your structure much more, and the table is a good idea. Did you put it in code for a reason, rather than displaying a markdown table?

[karoliskoncevicius]

I don't like the zebra stripes in GitHub table rendering. Also when you put normal text in one column but code in another it makes it look even weirder. When it's all in code the table is more "flat" looking. That's the only reason...

[moodymudskipper]

Alright, I'm not sure if it looks less weird to have a table in a code block but that's a detail either way. I think we can close this then

[karoliskoncevicius]

@moodymudskipper I think you are right - README seems to look better with normal tables here. If you want that version - it's in branch dev_readme now.