You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+60-25Lines changed: 60 additions & 25 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,28 +1,68 @@
1
-
# 🧑💻 Touch Win
2
-
3
-
> If you think that touch-win is a great project, consider making a small donation to be able to continue creating more projects like this. <ahref="https://github.com/sponsors/zitrocode">GitHub Sponsor</a>.
This project provides a simple and fast solution to create multiple files from a single command; Touch-win is inspired by the "touch" command found on Linux and UNIX based systems.
48
+
<divalign="center">
49
+
<imgsrc="./images/touch-win.jpg"width="90%">
50
+
</div>
51
+
<br>
8
52
9
-

53
+
Touch win is a cli program that helps you create various files with a single command, it is inspired by the "touch" command found natively in Linux and Unix based operating systems. Even though there are several programs/packages in [npmjs](https://npmjs.com) that help you get this command on Windows, **I assure you that there is no one like it**.
10
54
11
55
## ✨ Features
12
56
13
-
- Allows you to create multiple files with a single command.
14
-
- Automatically creates the necessary folders for the location of the file to create if it does not exist.
15
-
- Allows you to create files from a base path.
16
-
- Allows you to create files from a template.
17
-
18
-
<!-- ## ⚡️ Requirements -->
57
+
- It allows you to generate multiple files with a single command.
58
+
- Create folders automatically if they don't exist.
59
+
- Allows you to generate files from a base path.
60
+
- Allows you to generate files from a template.
19
61
20
62
## 📦 Installation
21
63
22
64
Install touch-win with your package manager:
23
65
24
-
#### NPM
25
-
26
66
```bash
27
67
npm install -g touch-win
28
68
```
@@ -37,23 +77,18 @@ touch-win --help
37
77
Usage: touch-win [options] [file ...]
38
78
39
79
Options:
40
-
--version Show version number [boolean]
41
-
-h, --help Show help[boolean]
42
-
-v, --verbose Run with verbose logging [boolean] [default: false]
43
-
-b, --base Base folder to place the file(s) [string]
44
-
-t, --template Template to generate files [string]
80
+
--version Show version number [boolean]
81
+
-h, --help Show help [boolean]
82
+
-v, --verbose Run with verbose logging [boolean] [default: false]
83
+
-b, --base Base folder to place the file(s) [string]
84
+
-t, --template Template to generate files [string]
45
85
Examples:
46
86
touch-win [options] [file ...] Create file(s)
47
87
48
88
touch-win src/bin/cli.js src/helpers/file.js src/helpers/directory.js Standard use
49
-
touch-win --base src/components/new_component Component.js Component.css Use with option "base"
50
-
touch-win --template src/components/new_component/Component.[rf] js test.js css Use with option "template"
51
-
touch-win --template config/webpack.[rf].js build dev common Use with option "template"
52
89
```
53
90
54
-
### Base
55
-
56
-
This option allows you to create files from a base path, this will help you not to repeat the same path in each file.
91
+
As you have seen, **Touch Win** has some options that will help you create a new file:
57
92
58
93
### Examples
59
94
@@ -98,4 +133,4 @@ successfully created "config\webpack.common.js"
98
133
99
134
---
100
135
101
-
**⚠️ WARNING:** This package is still under development, so it may have some bugs.
136
+
⚠️ **WARNING**: This package is still under development, so it may have some bugs.
0 commit comments