Skip to content

Commit ea65af9

Browse files
authored
docs: highlight notes and warnings
See https://github.com/orgs/community/discussions/16925 [skip ci]
1 parent ccb5c76 commit ea65af9

File tree

1 file changed

+9
-14
lines changed

1 file changed

+9
-14
lines changed

README.md

+9-14
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
# Query To App
22
Generates the endpoints (or a whole app) from a mapping (SQL query -> URL)
33

4-
>:warning: This is a proof of concept at this moment. Until it reaches a stable version, it might (and will) break a compatibility.
4+
> [!WARNING]
5+
> This is a proof of concept at this moment. Until it reaches a stable version, it might (and will) break a compatibility.
56
67
# How to use
78

@@ -67,20 +68,14 @@ Generates the endpoints (or a whole app) from a mapping (SQL query -> URL)
6768
| Golang | <pre>$ export DB_NAME=my-db DB_USER=my-user DB_PASSWORD=my-password<br/>$ go run *.go</pre>or<pre>$ go build -o app<br/>$ ./app</pre> |
6869
| Python | <pre>$ pip install -r requirements.txt<br/>$ export DB_NAME=my-db DB_USER=my-user DB_PASSWORD=my-password<br/>$ uvicorn app:app --port 3000</pre> |
6970

70-
---
71-
:bulb: **NOTE**
71+
> [!TIP]
72+
> While the example used `export` for setting up the environment variables, we don't recommend export variables that way! This was provided as an example to illustrate that an application follows [The Twelve Factors](https://12factor.net/config) and can be configured by passing environment variables. In real life, you will use docker, docker-compose, Kubernetes or other ways to run an app with required environment variables.
7273
73-
While the example used `export` for setting up the environment variables, we don't recommend export variables that way! This was provided as an example to illustrate that an application follows [The Twelve Factors](https://12factor.net/config) and can be configured by passing environment variables. In real life, you will use docker, docker-compose, Kubernetes or other ways to run an app with required environment variables.
74-
75-
---
76-
:bulb: **NOTE**
77-
78-
An app also supports other environment variables:
79-
80-
* `PORT`: a port to listen (defaults to `3000`)
81-
* `DB_HOST` a database host (defaults to `localhost`)
82-
83-
---
74+
> [!NOTE]
75+
> An app also supports other environment variables:
76+
>
77+
> * `PORT`: a port to listen (defaults to `3000`)
78+
> * `DB_HOST` a database host (defaults to `localhost`)
8479
</details>
8580
8681
1. Test that it works

0 commit comments

Comments
 (0)