JoshuaKGoldberg / JoshuaKGoldberg/create-typescript-app
📝 Documentation: Add examples of different kinds of projects
- Dominant language
- TypeScript
- Stars
- 1.4k
- Forks
- 89
- Avg merge
- 1m
- Merged PRs (30d)
- 3
Description
### Bug Report Checklist
- [X] I have pulled the latest `main` branch of the repository.
- [X] I have [searched for related issues](https://github.com/JoshuaKGoldberg/create-typescript-app/issues?q=is%3Aissue) and found none that matched my issue.
### Overview
create-typescript-app can be used for several different kinds of projects:
* Browser extension: e.g. [refined-saved-replies](https://github.com/JoshuaKGoldberg/refined-saved-replies)
* CLI: [github-username-to-emails](https://github.com/JoshuaKGoldberg/github-username-to-emails) [tidelift-me-up](https://github.com/JoshuaKGoldberg/tidelift-me-up)
* Framework plugin: e.g. [eslint-plugin-expect-type](https://www.npmjs.com/package/eslint-plugin-expect-type), [prettier-plugin-curly](https://github.com/JoshuaKGoldberg/prettier-plugin-curly)
* GitHub Action: e.g. [all-contributors-auto-action](https://github.com/JoshuaKGoldberg/all-contributors-auto-action), [schemar](https://github.com/johnnyreilly/schemar)
* Library: [are-docs-informative](https://github.com/JoshuaKGoldberg/are-docs-informative), [tidelift-me-up](https://github.com/JoshuaKGoldberg/tidelift-me-up)
* Website: [github-username-to-emails-site](https://github.com/JoshuaKGoldberg/github-username-to-emails-site), [tidelift-me-up-site](https://github.com/JoshuaKGoldberg/tidelift-me-up-site)
Each of those has some unique points, such as browser extensions using [`web-ext`](https://github.com/mozilla/web-ext). And there is some overlap: `tidelift-me-up` is both a CLI and a library.
I'd like to add a mention somewhere (maybe _FAQs_? maybe a new _Examples_ page?) of these different types of outputs. It should mention what the unique things you have to do to each one are.
### Additional Info
_No response_
Contributor guide
Assessment
This issue has not been assessed yet.