Commit e326f54
authored
chore: rewrite READMEs purpose-first and drop the build script for prepack (#12)
Rewrites every README to open with what the project and each package are
for, and lines them up with the orpc README shape: centered title, badge
block (codecov, npm downloads, MIT license, Discord, DeepWiki), package
table, and a License footer. Also removes the redundant `build` script
from the downgrader so `prepack` alone drives publishing, and adds the
MIT LICENSE file the packages already declared.
## Docs
- Root README explains the project and lists both packages with one-line
purposes, replacing a bare "OAS" title over the sponsors list.
- Package READMEs lead with the package name and purpose. Downgrader
mappings use shorter table cells and bullet lists, and document two
behaviors the old text missed: path parameters gain `required: true`,
and empty `required` arrays are dropped.
- Generated sponsors sections are byte-identical. `sync-sponsors` runs
end to end and reports zero changes with the new License section after
it.
## Packaging
- `pnpm pack` on the downgrader still runs unbuild via `prepack`;
nothing in docs or CI referenced `build`.
- LICENSE makes the shields license badge resolve. npm download badges
read "not found" until first publish.
- CodSpeed badge left out: the repo has no benchmarks or CodSpeed
project yet.
## Testing
- ESLint passes on all READMEs.
- README code samples verified: the types example type-checks, the
downgrader example produces the documented output.1 parent e86d61b commit e326f54
6 files changed
Lines changed: 227 additions & 79 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | | - | |
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
2 | 36 | | |
3 | 37 | | |
4 | 38 | | |
| |||
83 | 117 | | |
84 | 118 | | |
85 | 119 | | |
| 120 | + | |
| 121 | + | |
| 122 | + | |
| 123 | + | |
0 commit comments