Skip to content

Commit a477e02

Browse files
Rachael-Esclaridge
andauthored
Update README.md (#622)
* Update README.md Update readme to reflect the apiKey is set as a system property following feedback from #619 * Update README.md Co-authored-by: Simone Claridge <[email protected]> * Update README.md * Update README.md Co-authored-by: Simone Claridge <[email protected]>
1 parent 0ee4630 commit a477e02

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,10 @@ Note: *in the following instructions for setting the API key, if a `gradle.prope
2121
1. Open IntelliJ IDEA and select _File > Open..._.
2222
2. Choose one of the sample project directories (not the category folder) and click _OK_.
2323
3. Select _File > Project Structure..._ and ensure that the Project SDK and language level are set to use Java 11.
24-
4. Set your API key in the `gradle.properties` file located in the `/.gradle` folder within your home directory.
24+
4. Store your API key in the `gradle.properties` file located in the `/.gradle` folder within your home directory. The API key will be set as a Java system property when the sample is run.
25+
```
26+
apiKey = yourApiKey
27+
```
2528
5. Open the Gradle view with _View > Tool Windows > Gradle_.
2629
6. In the Gradle view, double-click the `run` task under _Tasks > application_ to run the app.
2730

@@ -31,15 +34,18 @@ Note: *in the following instructions for setting the API key, if a `gradle.prope
3134
2. In the import wizard, choose _Gradle > Existing Gradle Project_, then click _Next_.
3235
3. Choose one of the sample project directories (not the category folder) as the project root directory.
3336
4. Click _Finish_ to complete the import.
34-
5. Set your API key in the `gradle.properties` file located in the `/.gradle` folder within your home directory.
37+
5. Store your API key in the `gradle.properties` file located in the `/.gradle` folder within your home directory. The API key will be set as a Java system property when the sample is run.
38+
```
39+
apiKey = yourApiKey
40+
```
3541
6. Open the Gradle Tasks view with _Window > Show View > Other... > Gradle > Gradle Tasks_.
3642
7. In the Gradle Tasks view, double-click the `run` task under _{project_name} > application_ to run the app.
3743

3844
### Terminal
3945

4046
1. `cd` into one of the sample project directories (not the category folder).
4147
2. Run `gradle wrapper` to create the Gradle Wrapper
42-
3. Set your API key in the `gradle.properties` file located in the `/.gradle` folder within your home directory.
48+
3. Store your API key in the `gradle.properties` file located in the `/.gradle` folder within your home directory. The API key will be set as a Java system property when the sample is run.
4349
4. Run `./gradlew run` on Linux/Mac or `gradlew.bat run` on Windows to run the app.
4450

4551
### Java 11

0 commit comments

Comments
 (0)