I'd suggest changing your readme into reference-style documentation rather than tutorial-style. Tutorial style makes it hard to visually parse and find just what you need - you need to read the whole tutorial to figure out what's going on. Reference-style focuses on making it easy to visually parse by making it clear to the reader how to find the piece of information they need. My two cents.
I'd suggest changing your readme into reference-style documentation rather than tutorial-style. Tutorial style makes it hard to visually parse and find just what you need - you need to read the whole tutorial to figure out what's going on. Reference-style focuses on making it easy to visually parse by making it clear to the reader how to find the piece of information they need. My two cents.