Skip to content

docs: fix misleading internal import path in Getting Started guide #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ElizioMartins wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: fix misleading internal import path in Getting Started guide #4

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,12 +54,16 @@ Additionally to the `task.obx.go` there's an `objectbox-model.json` which holds

## Initializing ObjectBox

To use ObjectBox in our main application code, we use `Builder` and give it model information and optionally some other settings. The code with the model information is generated by the ObjectBox and you just need to use in your code:
To use ObjectBox in our main application code, we use `Builder` and give it model information and optionally some other settings. The code with the model information is generated by ObjectBox and you just need to use it in your code:

{% hint style="warning" %}
Replace `github.com/my-org/my-project` below with your own Go module name (as defined in your `go.mod` file).
{% endhint %}

```go
import (
"github.com/objectbox/objectbox-go/objectbox"
"github.com/objectbox/objectbox-go/examples/tasks/internal/model"
"github.com/my-org/my-project/internal/model"
)

func initObjectBox() *objectbox.ObjectBox {
Expand Down