Skip to content

Commit 37ed84f

Browse files
committed
Format credentials in README as a markdown table
@matthib https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet#tables
1 parent 6a7668c commit 37ed84f

1 file changed

Lines changed: 15 additions & 8 deletions

File tree

README.md

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -34,10 +34,13 @@ Currently all of the database related code can be found in the `core/db.js` file
3434
This includes the credentials for the database (host, user, password and db name) and can be changed in this file.
3535

3636
More conveniently the MySQL credentials can be provided via environment variables. Use the following environment variables:
37-
* MYSQL_HOST: Host address for the database
38-
* MYSQL_DB: Database Name
39-
* MYSQL_USER: MySQL User
40-
* MYSQL_PASS: MySQL Password
37+
38+
| Variable | Description |
39+
|--------------|-------------------------------|
40+
| `MYSQL_HOST` | Host address for the database |
41+
| `MYSQL_DB` | Database Name |
42+
| `MYSQL_USER` | MySQL User |
43+
| `MYSQL_PASS` | MySQL Password |
4144

4245
Currently we have two tables:
4346
* apikeys: Contains the apikeys required to perform authorized API request
@@ -52,10 +55,14 @@ For the mailer to work the smtp credentials need to be changed in this file as w
5255
Then the mailer will work and use the mail templates from `mails/entry/`
5356

5457
More conveniently the Mailer credentials can be provided via environment variables. Use the following environment variables:
55-
* MAIL_HOST: Host address for the mailer
56-
* MAIL_PORT: Port number for the mailer
57-
* MAIL_USER: Mailer User
58-
* MAIL_PASS: Mailer Password
58+
59+
| Variable | Description |
60+
|--------------|-------------------------------|
61+
| `MAIL_HOST` | Host address for the mailer |
62+
| `MAIL_PORT` | Port number for the mailer |
63+
| `MAIL_USER` | Mailer User |
64+
| `MAIL_PASS` | Mailer Password |
65+
5966

6067

6168
To debug and preview the emails, we use [MailHog](https://github.com/mailhog/MailHog).

0 commit comments

Comments
 (0)