Skip to content

Commit a75eb1f

Browse files
authored
add docs about new about.md behavior
1 parent ec4c5b0 commit a75eb1f

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

Diff for: mods/md-files.md

+4
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,10 @@ Geode mods can specify a long, free-form description typeset using Markdown by i
99

1010
This file is similar to a README, however **it's intended for people who use the mod**; you should also keep a README for developers interested in building / contributing to your mod.
1111

12+
> :information_source: As of [CLI v3.5.0](https://github.com/geode-sdk/cli/releases/tag/v3.5.0), if a `README.md` is present but not an `about.md`, the readme will be used as the mod description. \
13+
> If you don't want this behavior, then make an `about.md` file like usual.
14+
15+
1216
## Example
1317

1418
```md

0 commit comments

Comments
 (0)