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
+6-6
Original file line number
Diff line number
Diff line change
@@ -48,7 +48,7 @@ To reformat the whole source tree, just type `treefmt` in any folder. This is a
48
48
49
49
## Installation
50
50
51
-
You can install `treefmt` by downloading the binary. Find the binaries for different architectures [here](https://github.com/numtide/treefmt.go/releases).
51
+
You can install `treefmt` by downloading the binary. Find the binaries for different architectures [here](https://github.com/numtide/treefmt-go/releases).
52
52
Otherwise, you can install the package from source code — either with [Go], or with the help of [nix].
53
53
54
54
We describe the installation process in detail in the [docs].
@@ -76,7 +76,7 @@ To explore the tool’s flags and options, type:
76
76
$ treefmt --help
77
77
```
78
78
79
-
Additionally, there's a wrapper called [`treefmt-nix`](https://github.com/numtide/treefmt.go-nix) for using `treefmt` with [`nix`](https://github.com/NixOS/nix).
79
+
Additionally, there's a wrapper called [`treefmt-nix`](https://github.com/numtide/treefmt-go-nix) for using `treefmt` with [`nix`](https://github.com/NixOS/nix).
80
80
81
81
## Configuration
82
82
@@ -108,20 +108,20 @@ Before specifying the formatter in the config, make sure it’s installed.
108
108
109
109
To find and share existing formatter recipes, take a look at the [docs].
110
110
111
-
If you are a Nix user, you might also be interested in [treefmt-nix](https://github.com/numtide/treefmt.go-nix) to use Nix to configure and bring in
111
+
If you are a Nix user, you might also be interested in [treefmt-nix](https://github.com/numtide/treefmt-go-nix) to use Nix to configure and bring in
112
112
formatters.
113
113
114
114
## Compatibility
115
115
116
-
`treefmt` works with any formatter that adheres to the [following specification](https://github.com/numtide/treefmt.go/blob/main/docs/formatters-spec.md).
116
+
`treefmt` works with any formatter that adheres to the [following specification](https://github.com/numtide/treefmt-go/blob/main/docs/formatters-spec.md).
117
117
118
118
For instance, you can go for:
119
119
120
120
-[clang-format] for C/C++/Java/JavaScript/JSON/Objective-C/Protobuf/C#
121
121
- gofmt for Golang
122
122
- Prettier for JavaScript/HTML/CSS
123
123
124
-
Find the full list of supported formatters [here](https://numtide.github.io/treefmt.go/formatters).
124
+
Find the full list of supported formatters [here](https://numtide.github.io/treefmt-go/formatters).
125
125
126
126
## Upcoming features
127
127
@@ -183,7 +183,7 @@ Unless explicitly stated otherwise, any contribution intentionally submitted for
Copy file name to clipboardexpand all lines: docs/contributing.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -12,14 +12,14 @@ The `treefmt` binaries and this user guide are licensed under the [MIT license](
12
12
13
13
## Before you contribute
14
14
15
-
Here you can take a look at the [existing issues](https://github.com/numtide/treefmt.go/issues). Feel free to contribute, but make sure you have a
15
+
Here you can take a look at the [existing issues](https://github.com/numtide/treefmt-go/issues). Feel free to contribute, but make sure you have a
16
16
[GitHub account](https://github.com/join) first :slightly_smiling_face:.
17
17
18
18
If you're new to open source, please read GitHub's guide on [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/). It's a quick read,
19
19
and it's a great way to introduce yourself to how things work behind the scenes in open-source projects.
20
20
21
21
Before sending a pull request, make sure that you've read all the guidelines. If you don't understand something, please
22
-
[state your question clearly in an issue](https://github.com/numtide/treefmt.go/issues/new) or ask the community on the [treefmt matrix server](https://matrix.to/#/#treefmt:numtide.com).
22
+
[state your question clearly in an issue](https://github.com/numtide/treefmt-go/issues/new) or ask the community on the [treefmt matrix server](https://matrix.to/#/#treefmt:numtide.com).
0 commit comments