Skip to content

Commit ec34a6c

Browse files
committed
docs: readme
1 parent 1b955c8 commit ec34a6c

1 file changed

Lines changed: 6 additions & 29 deletions

File tree

README.md

Lines changed: 6 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -46,28 +46,6 @@ For an overview, see the [introductory blog post][].
4646
[godoc]: https://godoc.org/github.com/goforj/wire
4747
[travis]: https://travis-ci.com/google/wire
4848

49-
## Installing
50-
51-
Install Wire by running:
52-
53-
```shell
54-
go install github.com/goforj/wire/cmd/wire@latest
55-
```
56-
57-
and ensuring that `$GOPATH/bin` is added to your `$PATH`.
58-
59-
## Compatibility with google/wire
60-
61-
Wire remains compatible with codebases that import `github.com/google/wire`.
62-
The generator always emits a `//go:generate` line pointing at this fork, so
63-
running `go generate` consistently uses the maintained toolchain. If you want
64-
`go generate` to keep working with existing `github.com/google/wire` imports,
65-
add a module replacement:
66-
67-
```shell
68-
go mod edit -replace=github.com/google/wire=github.com/goforj/wire@latest
69-
```
70-
7149
## How Wire Works (in 60 seconds)
7250

7351
Wire is a **compile-time dependency injection** tool. Instead of building a runtime
@@ -86,7 +64,7 @@ func NewDB(cfg Config) (*sql.DB, error) {
8664
}
8765
````
8866

89-
Dependencies are expressed as function parameters no globals, no hidden state.
67+
Dependencies are expressed as function parameters - no globals, no hidden state.
9068

9169
### Injectors
9270

@@ -101,7 +79,7 @@ func InitializeApp(cfg Config) (*App, error) {
10179
}
10280
```
10381

104-
The generated output is plain Go readable, debuggable, and fast.
82+
The generated output is plain Go - readable, debuggable, and fast.
10583

10684
## Minimal Example
10785

@@ -181,10 +159,10 @@ For detailed guidance, see **Best Practices**.
181159

182160
If you're new to Wire, we recommend reading in this order:
183161
184-
1. **Tutorial** A guided introduction with a complete working example
185-
2. **User Guide** Full reference for providers, injectors, bindings, and advanced patterns
186-
3. **Best Practices** Design guidance for large codebases and libraries
187-
4. **FAQ** Design rationale and common questions
162+
1. **Tutorial** - A guided introduction with a complete working example
163+
2. **User Guide** - Full reference for providers, injectors, bindings, and advanced patterns
164+
3. **Best Practices** - Design guidance for large codebases and libraries
165+
4. **FAQ** - Design rationale and common questions
188166
189167
* [Tutorial](./_tutorial/README.md)
190168
* [User Guide](./docs/guide.md)
@@ -213,4 +191,3 @@ For questions and discussion, use
213191
This project follows the Go
214192
[Code of Conduct](./CODE_OF_CONDUCT.md).
215193
216-
```

0 commit comments

Comments
 (0)