Skip to content

Commit d65db34

Browse files
Optimize README
1 parent 0a4b963 commit d65db34

File tree

2 files changed

+9
-8
lines changed

2 files changed

+9
-8
lines changed

README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,29 +14,30 @@ npm i -g fastify-swc-typescript-server-bootstrap-cli
1414

1515
## Usage
1616

17-
After installation, bootstrap a new Fastify SWC server project using the command:
17+
After installation, bootstrap a new Fastify SWC server project using the `fastify-swc-server` command:
1818

1919
```bash
2020
fastify-swc-server [project-name]
2121
```
2222

23-
Replace `[project-name]` with the intended name for the project. This creates a new directory with the specified name, clones the Fastify SWC server setup, and configures the project accordingly.
23+
Replace `[project-name]` with the intended name for the project. This creates a new directory with the specified name, clones the Fastify SWC server repo, and configures the project accordingly.
2424

2525
## Current Features
2626

27-
- Clones a Fastify SWC Jest server boilerplate from [this repository](https://github.com/mattfsourcecode/fastify-swc-typescript-server).
28-
- Removes the original `.git` directory from the cloned repository and initializes a new git repository, allowing for a clean version control start.
27+
- Clones a boilerplate from [this repository](https://github.com/mattfsourcecode/fastify-swc-typescript-server).
28+
- Removes the original `.git` directory and initializes a new git repository for a clean version control start.
2929
- Updates the `package.json` with the specified project name and resets the author value to an empty string.
3030
- More customizations to be added...
3131

32+
<br>
3233
<img width="300" alt="logo" src="https://github.com/user-attachments/assets/a6907512-87a4-45de-9188-cdc494dfe5a8">
3334

3435
## Contributions and Issues
3536

36-
Contributions are welcome! If you have ideas or improvements, please open an issue first for discussion before submitting a pull request.
37+
Contributions are welcome! If you have ideas for improvements, please open an issue first for discussion before submitting a pull request.
3738

38-
The [npm module's codebase](https://github.com/mattfsourcecode/fastify-swc-typescript-server-bootstrap-cli) uses a testing suite with [Mocha](https://mochajs.org/) and [Chai](https://www.chaijs.com/), integrating [Husky](https://typicode.github.io/husky/) as a pre-commit [git hook](https://git-scm.com/book/ms/v2/Customizing-Git-Git-Hooks), ensuring all tests pass before staged changes can be committed.
39+
NOTE: The [npm module's codebase](https://github.com/mattfsourcecode/fastify-swc-typescript-server-bootstrap-cli) uses a testing suite with [Mocha](https://mochajs.org/) and [Chai](https://www.chaijs.com/), integrating [Husky](https://typicode.github.io/husky/) as a pre-commit [git hook](https://git-scm.com/book/ms/v2/Customizing-Git-Git-Hooks) to ensure all tests pass before staged changes can be committed.
3940

4041
You can report issues or start discussions here: [Open an issue](https://github.com/mattfsourcecode/fastify-swc-typescript-server-bootstrap-cli/issues)
4142

42-
For contributions and issues relating to the [codebase cloned](https://github.com/mattfsourcecode/fastify-swc-typescript-server) with the `fastify-swc-server` command, [open an issue here](https://github.com/mattfsourcecode/fastify-swc-typescript-server/issues).
43+
For contributions and issues regarding the [codebase cloned](https://github.com/mattfsourcecode/fastify-swc-typescript-server) with the `fastify-swc-server` command, [open an issue here](https://github.com/mattfsourcecode/fastify-swc-typescript-server/issues).

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "fastify-swc-typescript-server-bootstrap-cli",
3-
"version": "1.0.14",
3+
"version": "1.0.15",
44
"description": "CLI tool that accelerates the creation of new server projects using Fastify with SWC and Jest",
55
"main": "init.js",
66
"license": "MIT",

0 commit comments

Comments
 (0)