[x] Add a documentation.md file to a catalog directory in the repo root, matching this format.
[x] (Optional) If there's additional documentation referenced in the repo, add a additionalInfo.md file to a catalog directory in the repo root, matching this format.
[x] Update the relative paths in documentation.md to be absolute paths
[x] Add the new header image to the top of README.md and catalog/documentation.md.
[x] Ensure the README.md commands section matches Justin's snippet.
[x] Run npm start and let the CLI move the nr1.json
[x] Edit that file to make sure the name and description make sense.
Add metadata to the repository that matches the example laid out here.
config.json
file to acatalog
directory in the repo root, matching this format./screenshots
directory intocatalog
:README.md
.additionalInfo.md
file to acatalog
directory in the repo root, matching this format.documentation.md
to be absolute pathsREADME.md
andcatalog/documentation.md
.README.md
commands section matches Justin's snippet.npm start
and let the CLI move thenr1.json