Skip to content

Commit 77d65de

Browse files
committed
updates to starter readme
1 parent ac957c2 commit 77d65de

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

starter-sample/README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Starter Sample #REMOVE_ME_AFTER_EDITING
22

3+
[1-click deploy](https://portal.defang.dev/redirect?url=https%3A%2F%2Fgithub.com%2Fnew%3Ftemplate_name%3Dsample-<YOUR_SAMPLE_DIR#REMOVE_ME_AFTER_EDITING>-template%26template_owner%3DDefangSamples)
4+
35
This is a sample that shows the rough structure of an actual Defang sample. This top paragraph should give a bit of context about the project and what it does. The rest of the README should be a guide on how to use the sample. #REMOVE_ME_AFTER_EDITING
46

57
## Prerequisites
@@ -17,6 +19,15 @@ To run the application locally, you can use the following command:
1719
docker compose up
1820
```
1921

22+
## Configuration
23+
#REMOVE_ME_AFTER_EDITING - this section should be removed if there are no configuration values needed. The intro text can probably stay, but the list of configuration values should be updated/removed if there are none.
24+
25+
For this sample, you will need to provide the following [configuration](https://docs.defang.io/docs/concepts/configuration). Note that if you are using the 1-click deploy option, you can set these values as secrets in your GitHub repository and the action will automatically deploy them for you.
26+
27+
### `API_KEY` #REMOVE_ME_AFTER_EDITING
28+
An explanation of what the env var (`API_KEY`) is, etc.
29+
30+
2031
## Deploying
2132

2233
1. Open the terminal and type `defang login`

0 commit comments

Comments
 (0)