K6: Update README!

[ragnarlonn]

...and in general we want a best-practise way of using images in the README (might be nice with e.g. a GIF animation in it, showing command-line usage of k6)

[ghost]

https://asciinema.org/ maybe?

[liclac]

Opinions on this? https://asciinema.org/a/5lpa1ik4bnquwh53igj7tp1e8

[ragnarlonn]

Animations are great, makes a repo look much more interesting.

[ghost]

some more points:

• the logo should be replacing the k6 header
• a clear and concise description should follow (even people who are not familiar with load testing should understand it)
• the install section should be first up
• the general hierarchy should be like this:

(ci badges?)
(description)
(small usage example)
-> installation
-> usage
->-> scripting etc.
->-> cli usage etc.
-> contributing

[ghost]

some inspiration

[liclac]

130

[ragnarlonn]

The only thing I don't like is that it promises new things we don't currently have (brew and apt packages). Introducing new, unfilled dependencies is something that complicates an issue and slows down the release process for new things or updates substantially. I would have updated the README with the current installation methods and then created two new issues for creating brew and apt packages. Each issue can then stand on its own feet, is easy to resolve, and there are no dependencies.

[liclac]

I'm gonna get on at least homebrew packaging before the presentations next week, gonna have a shot at Debian and Ubuntu too and see how much I remember from my days maintaining KCT packages for both.

[ghost]

from my experience creating a homebrew tap and a formula is a 20-minute effort, so it shouldn't be a problem

[liclac]

You can now do:

brew tap loadimpact/k6
brew install k6

Working on Ubuntu packages.

[ragnarlonn]

Suggest removing the reference to Debian packages (but adding a new issue about it), adding the build instructions again, at the end of the file, and then merging this (or add the build instructions in a separate BUILD.md or similar, and just point to it in the README).

[liclac]

Merged!