Skip to content

Commit f4c9505

Browse files
authored
Merge pull request #24 from ss49919201/update-readme-to-include-go-install
Update README to include installation instructions for `go install`
2 parents b6fd9a3 + 2f453cc commit f4c9505

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

README.md

+8-2
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,16 @@ Dockerfile formatter, and a modern version of [dockfmt](https://github.com/jessf
44

55
## Installation
66

7+
### Binaries
8+
79
Binaries are available from the [releases](https://github.com/reteps/dockerfmt/releases) page.
810

11+
### go install
12+
13+
```bash
14+
go install github.com/reteps/dockerfmt@latest
15+
```
16+
917
## Usage
1018

1119
```output
@@ -52,7 +60,6 @@ repos:
5260
5361
- The `RUN` parser currently doesn't support grouping or semicolons in commands. Adding semicolon support is a non-trivial task.
5462

55-
5663
- No line wrapping is performed for long JSON commands
5764
- The `# escape=X` directive is not supported
5865

@@ -92,7 +99,6 @@ RUN echo "hello" \
9299

93100
This is surprisingly [non-trivial](https://github.com/moby/buildkit/issues/5889) as we want to attach the comments to their position in the formatted output, but they are stripped by the parser beforehand.
94101

95-
96102
## JS Bindings
97103

98104
The JS bindings are available in the `js` directory. More information on how to use them can be found in the [README](js/README.md) file.

0 commit comments

Comments
 (0)