npm based projects make it really easy to factor out individual general-purpose functions as packages.
It's a really nice way to work. Separate packages get their own README, and the combined project is smaller and easier to reason about.
miniblog.
Related Posts
12
There are docs resources like https://diataxis.fr/ that categorise documents based on format and intended audience.
They don't say where you should start, or what order you should write docs.
I'm currently thinking README > reference > tutorial > how-tos. Agree/disagree?
Today I learnt that Lua projects often use *3* spaces for indentation! https://github.com/luarocks/lua-style-guide/blob/master/README.md#indentation-and-formatting
I initially thought something was very wrong with editor config.
I've released difftastic 0.13! In this release:
* Added support for Bash, Common Lisp and Ruby
* Improved C, CSS, JS, JSON, TS and plain text in comments
* A bunch of new explanatory screenshots in the README
