Skip to content

Commit e83faf6

Browse files
committed
doc(main): Updated documentation
1 parent bba3ced commit e83faf6

File tree

3 files changed

+8
-8
lines changed

3 files changed

+8
-8
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,8 @@ This template is following the [recommended project layout](https://go.dev/doc/m
3333
- `configs/`: configuration files
3434
- `internal/`:
3535
- `worker/`: worker and test examples
36-
- `bootstrap.go`: bootstrap (modules, lifecycles, etc)
37-
- `services.go`: services registration
36+
- `bootstrap.go`: bootstrap
37+
- `register.go`: dependencies registration
3838

3939
### Makefile
4040

internal/bootstrap.go

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,12 +17,12 @@ func init() {
1717
// RootDir is the application root directory.
1818
var RootDir string
1919

20-
// Bootstrapper can be used to load modules, options, services and bootstraps your application.
20+
// Bootstrapper can be used to load modules, options, dependencies and bootstraps your application.
2121
var Bootstrapper = fxcore.NewBootstrapper().WithOptions(
22-
// modules
22+
// modules registration
2323
fxworker.FxWorkerModule,
24-
// services
25-
ProvideServices(),
24+
// dependencies registrations
25+
Register(),
2626
)
2727

2828
// Run starts the application, with a provided [context.Context].

internal/services.go renamed to internal/register.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ import (
66
"go.uber.org/fx"
77
)
88

9-
// ProvideServices is used to register the application services.
10-
func ProvideServices() fx.Option {
9+
// Register is used to register the application dependencies.
10+
func Register() fx.Option {
1111
return fx.Options(
1212
fxworker.AsWorker(worker.NewExampleWorker),
1313
)

0 commit comments

Comments
 (0)