@saulpaulus17/node-module-generator 2.0.2 → 2.0.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +21 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -5,6 +5,15 @@
|
|
|
5
5
|
<a href="https://github.com/saul-paulus/node-module-generator/actions/workflows/ci.yml">
|
|
6
6
|
<img src="https://github.com/saul-paulus/node-module-generator/actions/workflows/ci.yml/badge.svg" alt="CI Status">
|
|
7
7
|
</a>
|
|
8
|
+
<a href="https://www.npmjs.com/package/@saulpaulus17/node-module-generator">
|
|
9
|
+
<img src="https://img.shields.io/npm/v/@saulpaulus17/node-module-generator.svg" alt="NPM Version" />
|
|
10
|
+
</a>
|
|
11
|
+
<a href="https://www.npmjs.com/package/@saulpaulus17/node-module-generator">
|
|
12
|
+
<img src="https://img.shields.io/npm/dt/@saulpaulus17/node-module-generator.svg" alt="NPM Downloads" />
|
|
13
|
+
</a>
|
|
14
|
+
<a href="https://github.com/saul-paulus/node-module-generator/blob/main/LICENSE">
|
|
15
|
+
<img src="https://img.shields.io/npm/l/@saulpaulus17/node-module-generator.svg" alt="License" />
|
|
16
|
+
</a>
|
|
8
17
|
</p>
|
|
9
18
|
</div>
|
|
10
19
|
|
|
@@ -26,6 +35,10 @@ It instantly scaffolds fully-tested, decoupled, and highly cohesive module struc
|
|
|
26
35
|
|
|
27
36
|
## 📦 Installation
|
|
28
37
|
|
|
38
|
+
### Prerequisites
|
|
39
|
+
- **Node.js**: v18.0.0 or higher.
|
|
40
|
+
- **NPM** or **Yarn**.
|
|
41
|
+
|
|
29
42
|
To use this CLI tool locally or globally on your machine, you can install it directly from NPM.
|
|
30
43
|
|
|
31
44
|
```bash
|
|
@@ -98,6 +111,14 @@ The scaffolded code integrates perfectly if you are using the following librarie
|
|
|
98
111
|
- **[Jest](https://jestjs.io/)** - For the colocated testing environments
|
|
99
112
|
- **[Joi](https://joi.dev/)** - For infrastructure schema validations
|
|
100
113
|
|
|
114
|
+
## 🤝 Contributing
|
|
115
|
+
|
|
116
|
+
Contributions are always welcome! Feel free to open issues or submit Pull Requests.
|
|
117
|
+
1. Fork the repo and create your branch (`git checkout -b feature/amazing-feature`).
|
|
118
|
+
2. Commit your changes (`git commit -m 'feat: add amazing feature'`).
|
|
119
|
+
3. Push to the branch (`git push origin feature/amazing-feature`).
|
|
120
|
+
4. Open a Pull Request.
|
|
121
|
+
|
|
101
122
|
## 📝 License
|
|
102
123
|
|
|
103
124
|
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
|
package/package.json
CHANGED