Skip to content

Commit 193e519

Browse files
author
David Blackman
authored
Update README.md
1 parent 01c5bcc commit 193e519

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

README.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -122,14 +122,15 @@ An example config looks like this
122122
prod: {
123123
host: 'prod.api.com',
124124
aliases: ['production'],
125+
protocol: 'https',
125126
}
126127
staging: {
127-
host: 'staging.api.com'
128+
host: 'staging.api.com',
129+
protocol: 'https',
128130
},
129131
local: {
130132
host: 'localhost:8000',
131133
keyEnv: 'staging',
132-
protocol: 'http',
133134
},
134135
user: {
135136
takesArg: true,
@@ -140,7 +141,7 @@ An example config looks like this
140141
}
141142
```
142143

143-
This defines a pretty common server setup. There is a production API at prod.api.com. It implicitly defines a "prod" key env in our config. There is a staging api at staging.api.com with a "staging" key env. Additionally, developers run local apis at localhost:8000, which use staging keys and should be communicated with over http (default is https). Finally, each user has their own staging env at USER-staging.api.com which again uses staging keys.
144+
This defines a pretty common server setup. There is a production API at prod.api.com, that uses https (the default is http). It implicitly defines a "prod" key env in our config. There is a staging api at staging.api.com with a "staging" key env. Additionally, developers run local apis at localhost:8000, which use staging keys and should be communicated with over http (the default). Finally, each user has their own staging env at USER-staging.api.com which again uses staging keys.
144145

145146
Additionally, for this config, we would add some environment variables, optionally in a .env file loaded by dotenv to make our lives even easier. That file would look like
146147

0 commit comments

Comments
 (0)