diff --git a/README.md b/README.md index b13e6e7..fc4d866 100644 --- a/README.md +++ b/README.md @@ -3228,6 +3228,20 @@ mod? foo 'bar.just' mod? foo 'baz.just' ``` +Modules may be given doc comments which appear in `--list` +outputmaster: + +```mf +# foo is a great module! +mod foo +``` + +```sh +$ just --list +Available recipes: + foo ... # foo is a great module! +``` + See the [module stabilization tracking issue](https://github.com/casey/just/issues/929) for more information.