Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# SimpleDoc

[![npm version](https://img.shields.io/npm/v/@simpledoc/simpledoc.svg)](https://www.npmjs.com/package/@simpledoc/simpledoc)
[![npm downloads](https://img.shields.io/npm/dm/@simpledoc/simpledoc.svg)](https://www.npmjs.com/package/@simpledoc/simpledoc)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

> Lightweight standard for organizing Markdown documentation in codebases

SimpleDoc defines a small set of rules for the naming and placement of Markdown files in a codebase, agnostic of any documentation framework.
Expand Down Expand Up @@ -40,10 +44,10 @@ Configuration for tooling can be shared in `simpledoc.json` and overridden per-u

## Install

Install the bundled agent skill + `AGENTS.md` instructions (no doc migrations):
Install the bundled agent skill (interactive wizard picks your agent and scope):

```bash
npx -y @simpledoc/simpledoc install
npx -y @simpledoc/simpledoc --skill install simpledoc
```

## Migrate
Expand Down
30 changes: 26 additions & 4 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@
"dependencies": {
"@clack/prompts": "^0.11.0",
"commander": "^11.0.0",
"skillflag": "^0.1.3"
"skillflag": "^0.1.4"
},
"devDependencies": {
"@eslint/js": "^9.0.0",
Expand Down