Skip to content

Commit 2853db6

Browse files
committed
Updated Documentation
1 parent 02b6633 commit 2853db6

File tree

2 files changed

+14
-4
lines changed

2 files changed

+14
-4
lines changed

README.md

+12-3
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,10 @@ But can be used in any file which contains html (".jsx", ".vue", ".twig") with s
1717
- [Replace command options](#replace-command-options)
1818
- [Check command options](#check-command-options)
1919
- [Usage](#usage)
20+
- [Just affix it!](#just-affix-it)
21+
- [Force replace](#force-replace)
22+
- [One File](#work-with-one-file)
23+
- [Choose Executable](#executables)
2024

2125
# Installation
2226
### Composer
@@ -46,7 +50,7 @@ Download binary [file](https://github.com/MaestroError/html-strings-affixer/rele
4650

4751

4852
### MacOS
49-
Download an [archive](https://github.com/MaestroError/html-strings-affixer/releases/latest/download/hsamac.zip), Unzip it, get "hsamac" or "hsamacm1" file in needed directory, give to it executable permissions and run with `./hsamac`/`./hsamacm1`
53+
Download an [archive](https://github.com/MaestroError/html-strings-affixer/releases/latest/download/hsamac.zip), Unzip it, get "hsamac" or "hsamacm1" file in needed directory, give to it executable permissions and run with `./hsamac` or `./hsamacm1`
5054

5155

5256
### From source
@@ -150,11 +154,15 @@ Sometimes you will need to perform some commands only on single file, to reduce
150154
```
151155

152156
#### Executables
153-
There are several executables for different platforms, choose your one and use. They are working exactly same way, you are changing just executable file name in commands:
157+
There are several executables for different platforms, choose your one and use it. They are working the exactly same way, you are changing just the executable file name in command.
154158
- Linux: `./vendor/bin/hsa`
155159
- Windows: `./vendor/bin/hsawin`
156160
- MacOS: `./vendor/bin/hsamac`
157-
- MacOS arm64 (m1): `./vendor/bin/hsamacm1`
161+
- MacOS arm64 (m1): `./vendor/bin/hsamacm1`
162+
163+
*Note: I am planning to create single command, which will work for any platform, but for now, it is as it is :smile:*
164+
165+
158166

159167
----------------------------------------------------------------
160168
----------------------------------------------------------------
@@ -209,6 +217,7 @@ There are several executables for different platforms, choose your one and use.
209217
- Refactor app with Cobra package
210218
- Use log files to undo last changes in folder_to_scan from log_folder (for dry run)
211219
- add command: "watch" (for live updates) and "undo" (Undo last changes)
220+
- Make single executable/command (Bridge) for any platform
212221

213222
#### Resources
214223
- [goreleaser](https://goreleaser.com/) +

app/app.go

+2-1
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,7 @@ func Shutdown() {
7575
os.Exit(1)
7676
}
7777

78+
// First entry point after bootstrapping
7879
func resolveCommands() {
7980
if len(os.Args) > 1 {
8081
switch os.Args[1] {
@@ -429,7 +430,7 @@ func checkConfigsAnyCommand() {
429430
shutdown = true
430431
}
431432
if len(Configuration.GetFileTypes()) <= 0 {
432-
Reporter.AddError("'file_types' is required config")
433+
Reporter.AddError("'file_types' (--allowed) is required config")
433434
shutdown = true
434435
}
435436
if shutdown {

0 commit comments

Comments
 (0)