ts-init-template 1.0.8 โ†’ 1.0.10

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.
Files changed (2) hide show
  1. package/package.json +1 -1
  2. package/readme.md +33 -9
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ts-init-template",
3
- "version": "1.0.8",
3
+ "version": "1.0.10",
4
4
  "description": "A TS project template for TS projects. This script will setup all the ts enviroment with 1 command. ",
5
5
  "main": "index.js",
6
6
  "author": "SigismundBT",
package/readme.md CHANGED
@@ -1,6 +1,8 @@
1
1
  # ts-init-template
2
2
 
3
- > A minimal CLI to bootstrap a clean TypeScript project with zero friction.
3
+ [![npm version](https://img.shields.io/npm/v/ts-init-template?color=blue)](https://www.npmjs.com/package/ts-init-template)
4
+
5
+ > ๐Ÿงช A minimal CLI tool to instantly scaffold a clean TypeScript project with zero config.
4
6
 
5
7
  ---
6
8
 
@@ -14,26 +16,48 @@
14
16
 
15
17
  ---
16
18
 
17
- ## ๐Ÿ“ฆ Usage
19
+ ## ๐Ÿ“ฆ Quick Install
20
+
21
+ ```
22
+ npx ts-init-template
23
+ ```
24
+
25
+ > Youโ€™ll need to run `yarn init` or `npm init -y` first.
26
+
27
+ ---
18
28
 
19
- ### ๐Ÿ’ก With Yarn
29
+ ## ๐Ÿ’ก Usage
20
30
 
21
- ```bash
31
+ ### With Yarn
22
32
 
33
+ ```
23
34
  yarn init
24
35
  npx ts-init-template
25
36
  yarn build
26
37
  yarn start
27
38
  ```
28
39
 
29
- ### ๐Ÿ’ก With NPM
30
-
31
- ```bash
40
+ ### With NPM
32
41
 
33
- npm init
42
+ ```
43
+ npm init -y
34
44
  npx ts-init-template
35
45
  npm run build
36
46
  npm run start
37
47
  ```
38
48
 
39
- ๐Ÿ” Remember: Every time you change your files in `/src`, run `yarn build` or `npm run build` again to compile.
49
+ ๐Ÿ” **Remember:** Every time you change your files in `src/`,
50
+ run `yarn build` or `npm run build` again to compile.
51
+
52
+ ---
53
+
54
+ ## ๐Ÿ”— Links
55
+
56
+ - ๐Ÿ“ฆ [View on npm](https://www.npmjs.com/package/ts-init-template)
57
+ - ๐Ÿง‘โ€๐Ÿ’ป [Source on GitHub](https://github.com/SigismundBT/ts_init_template)
58
+
59
+ ---
60
+
61
+ ## ๐Ÿ“„ License
62
+
63
+ MIT ยฉ SigismundBT