ts-init-template 1.0.9 โ†’ 1.0.11

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 +14 -4
  2. package/readme.md +44 -9
package/package.json CHANGED
@@ -1,14 +1,24 @@
1
1
  {
2
2
  "name": "ts-init-template",
3
- "version": "1.0.9",
3
+ "version": "1.0.11",
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",
7
7
  "license": "MIT",
8
- "dependencies": {},
9
8
  "devDependencies": {},
10
9
  "type": "module",
11
10
  "bin": {
12
- "ts-init": "./index.js"
13
- }
11
+ "ts-init": "index.js"
12
+ },
13
+ "scripts": {
14
+ "test": "echo \"Error: no test specified\" && exit 1"
15
+ },
16
+ "repository": {
17
+ "type": "git",
18
+ "url": "git+https://github.com/SigismundBT/ts_init_template.git"
19
+ },
20
+ "bugs": {
21
+ "url": "https://github.com/SigismundBT/ts_init_template/issues"
22
+ },
23
+ "homepage": "https://github.com/SigismundBT/ts_init_template#readme"
14
24
  }
package/readme.md CHANGED
@@ -1,6 +1,19 @@
1
+
2
+ # ๐Ÿšจ This package is deprecated
3
+
4
+ Please use the new package:
5
+
6
+ ๐Ÿ‘‰ [ts-init-go](https://www.npmjs.com/package/ts-init-go)
7
+
8
+ ```bash
9
+ npx ts-init-go
10
+ ```
11
+
1
12
  # ts-init-template
2
13
 
3
- > A minimal CLI to bootstrap a clean TypeScript project with zero friction.
14
+ [![npm version](https://img.shields.io/npm/v/ts-init-template?color=blue)](https://www.npmjs.com/package/ts-init-template)
15
+
16
+ > ๐Ÿงช A minimal CLI tool to instantly scaffold a clean TypeScript project with zero config.
4
17
 
5
18
  ---
6
19
 
@@ -14,26 +27,48 @@
14
27
 
15
28
  ---
16
29
 
17
- ## ๐Ÿ“ฆ Usage
30
+ ## ๐Ÿ“ฆ Quick Install
18
31
 
19
- ### ๐Ÿ’ก With Yarn
32
+ ```
33
+ npx ts-init-template
34
+ ```
20
35
 
21
- ```bash
36
+ > Youโ€™ll need to run `yarn init` or `npm init -y` first.
37
+
38
+ ---
22
39
 
40
+ ## ๐Ÿ’ก Usage
41
+
42
+ ### With Yarn
43
+
44
+ ```
23
45
  yarn init
24
46
  npx ts-init-template
25
47
  yarn build
26
48
  yarn start
27
49
  ```
28
50
 
29
- ### ๐Ÿ’ก With NPM
51
+ ### With NPM
30
52
 
31
- ```bash
32
-
33
- npm init
53
+ ```
54
+ npm init -y
34
55
  npx ts-init-template
35
56
  npm run build
36
57
  npm run start
37
58
  ```
38
59
 
39
- ๐Ÿ” Remember: Every time you change your files in `src/`, run `yarn build` or `npm run build` again to compile.
60
+ ๐Ÿ” **Remember:** Every time you change your files in `src/`,
61
+ run `yarn build` or `npm run build` again to compile.
62
+
63
+ ---
64
+
65
+ ## ๐Ÿ”— Links
66
+
67
+ - ๐Ÿ“ฆ [View on npm](https://www.npmjs.com/package/ts-init-template)
68
+ - ๐Ÿง‘โ€๐Ÿ’ป [Source on GitHub](https://github.com/SigismundBT/ts_init_template)
69
+
70
+ ---
71
+
72
+ ## ๐Ÿ“„ License
73
+
74
+ MIT ยฉ SigismundBT