-
Notifications
You must be signed in to change notification settings - Fork 296
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
README: Reword introduction, link to tutorial
This rewords the introduction in the readme to better state the benefits of using Fx, and links to the get-started tutorial to help users get started. Part of this is to add the root README to the list of files processed by mdox, as a result of which some of the links are also rewritten. (mdox prefers inline links, not reference style links, and there's no way to change that right now.)
- Loading branch information
Showing
2 changed files
with
16 additions
and
19 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,35 +1,32 @@ | ||
# :unicorn: Fx [![GoDoc][doc-img]][doc] [![Github release][release-img]][release] [![Build Status][ci-img]][ci] [![Coverage Status][cov-img]][cov] [![Go Report Card](https://goreportcard.com/badge/go.uber.org/fx)](https://goreportcard.com/report/go.uber.org/fx) | ||
# :unicorn: Fx [![GoDoc](https://pkg.go.dev/badge/go.uber.org/fx)](https://pkg.go.dev/go.uber.org/fx) [![Github release](https://img.shields.io/github/release/uber-go/fx.svg)](https://github.com/uber-go/fx/releases) [![Build Status](https://github.com/uber-go/fx/actions/workflows/go.yml/badge.svg)](https://github.com/uber-go/fx/actions/workflows/go.yml) [![Coverage Status](https://codecov.io/gh/uber-go/fx/branch/master/graph/badge.svg)](https://codecov.io/gh/uber-go/fx/branch/master) [![Go Report Card](https://goreportcard.com/badge/go.uber.org/fx)](https://goreportcard.com/report/go.uber.org/fx) | ||
|
||
An application framework for Go that: | ||
Fx is a dependency injection system for Go. | ||
|
||
- Makes dependency injection easy. | ||
- Eliminates the need for global state and `func init()`. | ||
**Benefits** | ||
|
||
- Eliminate globals: Fx helps you remove global state from your application. | ||
No more `init()` or global variables. Use Fx-managed singletons. | ||
- Code reuse: Fx lets teams within your organization build loosely-coupled | ||
and well-integrated shareable components. | ||
- Battle tested: Fx is the backbone of nearly all Go services at Uber. | ||
|
||
## Installation | ||
|
||
We recommend locking to [SemVer](http://semver.org/) range `^1` using [go mod](https://github.com/golang/go/wiki/Modules): | ||
Use Go modules to install Fx in your application. | ||
|
||
```shell | ||
go get go.uber.org/fx@v1 | ||
``` | ||
|
||
## Getting started | ||
|
||
To get started with Fx, [start here](docs/get-started/README.md). | ||
|
||
## Stability | ||
|
||
This library is `v1` and follows [SemVer](http://semver.org/) strictly. | ||
|
||
No breaking changes will be made to exported APIs before `v2.0.0`. | ||
|
||
This project follows the [Go Release Policy][release-policy]. Each major | ||
This project follows the [Go Release Policy](https://golang.org/doc/devel/release.html#policy). Each major | ||
version of Go is supported until there are two newer major releases. | ||
|
||
[doc-img]: https://pkg.go.dev/badge/go.uber.org/fx | ||
[doc]: https://pkg.go.dev/go.uber.org/fx | ||
[release-img]: https://img.shields.io/github/release/uber-go/fx.svg | ||
[release]: https://github.com/uber-go/fx/releases | ||
[ci-img]: https://github.com/uber-go/fx/actions/workflows/go.yml/badge.svg | ||
[ci]: https://github.com/uber-go/fx/actions/workflows/go.yml | ||
[cov-img]: https://codecov.io/gh/uber-go/fx/branch/master/graph/badge.svg | ||
[cov]: https://codecov.io/gh/uber-go/fx/branch/master | ||
[report-card-img]: https://goreportcard.com/badge/github.com/uber-go/fx | ||
[report-card]: https://goreportcard.com/report/github.com/uber-go/fx | ||
[release-policy]: https://golang.org/doc/devel/release.html#policy |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters