Skip to content

Commit ce14d98

Browse files
committed
docs: update readme & description
1 parent 92f260f commit ce14d98

File tree

2 files changed

+10
-6
lines changed

2 files changed

+10
-6
lines changed

README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Create TypeScript Package
22

3-
A template project for creating TypeScript packages.
3+
A template project for developing & publishing TypeScript packages.
44

55
## Configuration
66

@@ -27,13 +27,17 @@ A template project for creating TypeScript packages.
2727

2828
## Structure
2929

30-
- `src/` - TypeScript source files.
31-
- `**/__tests__/` - Test files.
32-
- `dist/` - Compiled JavaScript files.
30+
- `src/` - TypeScript source files
31+
- `**/__tests__/` - Test files
32+
- `dist/` - Compiled JavaScript files
3333

3434
## Tools
3535

36-
This template uses [tsup](https://tsup.egoist.dev/) for transpiling & bundling, [Vitest](https://vitest.dev/) for testing, [ESlint](https://eslint.org/) & [TypeScript ESlint](https://typescript-eslint.io/) (with the strictest configuration) for linting, [Prettier](https://prettier.io/) for formatting, and [Changesets](https://github.com/changesets/changesets) for versioning & publishing.
36+
This template uses [tsup](https://tsup.egoist.dev/) for transpiling & bundling,
37+
[Vitest](https://vitest.dev/) for testing,
38+
[ESLint](https://eslint.org/) & [TypeScript ESLint](https://typescript-eslint.io/) (with the strictest configuration) for linting,
39+
[Prettier](https://prettier.io/) for formatting,
40+
and [Changesets](https://github.com/changesets/changesets) for versioning & publishing.
3741

3842
## Development Flow
3943

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "create-typescript-package",
3-
"description": "A template project for creating TypeScript packages",
3+
"description": "A template project for developing & publishing TypeScript packages",
44
"version": "0.0.0",
55
"author": "StyleShit",
66
"license": "MIT",

0 commit comments

Comments
 (0)