Skip to content

Commit 9aa51ed

Browse files
authored
minor readme changes; add stability indicator (#50)
1 parent 6f6f7d5 commit 9aa51ed

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# nject - dependency injection
22

3+
[![Stability: Active](https://masterminds.github.io/stability/active.svg)](https://masterminds.github.io/stability/active.html)
34
[![GoDoc](https://godoc.org/github.com/muir/nject?status.png)](https://pkg.go.dev/github.com/muir/nject)
45
![unit tests](https://github.com/muir/nject/actions/workflows/go.yml/badge.svg)
56
[![report card](https://goreportcard.com/badge/github.com/muir/nject)](https://goreportcard.com/report/github.com/muir/nject)
@@ -17,9 +18,11 @@ users to do type assertions.
1718
Dependencies are injected via a call chain: list functions to be called
1819
that take and return various parameters. The functions will be called
1920
in order using the return values from earlier functions as parameters
20-
for later functions.
21+
for later functions. Only the functions that are needed to be called in
22+
order to be able to call the last function in the chain are invoked. Then
23+
the last function in the chain is called.
2124

22-
Parameters are identified by their types. To have two different int
25+
Parameters are identified by their types. To have two different `int`
2326
parameters, define custom types.
2427

2528
Type safety is checked before any functions are called.
@@ -66,7 +69,7 @@ is called. Bind() does not run the chain.
6669

6770
Run() is used when ad-hoc injection is desired and performance is not
6871
critical. Run is appropriate when starting servers and running tests.
69-
It is not recommended for http endpoint handlers. Run exectes the
72+
It is not recommended for HTTP endpoint handlers. Run exectes the
7073
chain immediately.
7174

7275
### Identified by type

0 commit comments

Comments
 (0)