Skip to content

Commit 6069a76

Browse files
committed
Give generator statistics its own headline
Keeps the instructions more simple
1 parent 694c40e commit 6069a76

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

getting-started.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -69,9 +69,9 @@ The generator requires write permissions in your project directory to generate t
6969
#### To run the generator from Xcode
7070

7171
1. Right-click your project in the Project navigator and click **ObjectBoxGeneratorCommand**,
72-
2. Select the target that contains your ObjectBox entity classes. The generator plugin sends anonymous usage statistics to the ObjectBox team. If you wish to opt-out, collapse the **Arguments** section below the list of targets and add the `--no-statistics` argument there.
72+
2. Select the target that contains your ObjectBox entity classes.
7373
3. When asked, allow the command to change files.
74-
4. When asked, allow the command to open network connections to send anonymous usage statistics to the ObjectBox team. You need to provide the permission even if you had opt-out of the usage statistics.
74+
4. When asked, allow the command to open network connections.
7575
5. Once the command has finished, add the generated source file (`generated/EntityInfo-<target-name>.generated.swift`) to your project.
7676

7777
#### To run the generator from the command line
@@ -82,18 +82,18 @@ Use this command:
8282
swift package plugin --allow-writing-to-package-directory --allow-network-connections all objectbox-generator --target <target-name>
8383
```
8484

85-
The generator plugin sends anonymous usage statistics to the ObjectBox team. If you wish to opt-out, pass the `--no-statistics` flag to the generator,
86-
87-
```shell
88-
swift package plugin --allow-writing-to-package-directory --allow-network-connections all objectbox-generator --target <target-name> --no-statistics
89-
```
90-
9185
The available targets can be viewed in the `Package.swift` file or with the following command,
9286

9387
```shell
9488
swift package describe
9589
```
9690

91+
#### Generator statistics
92+
93+
The generator sends anonymous usage statistics to help the ObjectBox team improve ObjectBox and its generator.
94+
If you wish to opt out, pass the `--no-statistics` flag to the generator.
95+
In Xcode, this is done in the **Arguments** section below the list of targets.
96+
9797
### Review and keep generated files
9898

9999
Among other files ObjectBox generates a JSON **model file**, by default to `model-<target-name>.json` where `<target-name>` is the name of an Xcode target, e.g. `NotesExample-iOS`.

0 commit comments

Comments
 (0)