Skip to content

Commit ff58fda

Browse files
committed
Add formatting
1 parent 9b221cd commit ff58fda

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ There are also proof-of-concept ports of this script that only support basic RES
3434

3535
## Installation
3636

37-
This is a single file application! Upload "api.php" somewhere and enjoy!
37+
This is a single file application! Upload "`api.php`" somewhere and enjoy!
3838

3939
For local development you may run PHP's built-in web server:
4040

@@ -48,7 +48,7 @@ Dont forget to modify the configuration at the bottom of the file.
4848

4949
## Configuration
5050

51-
Edit the following lines in the bottom of the file "api.php":
51+
Edit the following lines in the bottom of the file "`api.php`":
5252

5353
$config = new Config([
5454
'username' => 'xxx',
@@ -58,27 +58,27 @@ Edit the following lines in the bottom of the file "api.php":
5858

5959
These are all the configuration options and their default value between brackets:
6060

61-
- "driver": "mysql" (default), "pgsql" or "sqlsrv"
62-
- "address": Hostname of the database server ("localhost")
61+
- "driver": "`mysql`" (default), "`pgsql`" or "`sqlsrv`"
62+
- "address": Hostname of the database server ("`localhost`")
6363
- "port": TCP port of the database server (defaults to driver default)
6464
- "username": Username of the user connecting to the database (no default)
6565
- "password": Password of the user connecting to the database (no default)
6666
- "database": Database the connecting is made to (no default)
67-
- "middlewares": List of middlewares to load ("cors")
68-
- "controllers": List of controllers to load ("records,openapi")
69-
- "openApiBase": OpenAPI info ("{"info":{"title":"PHP-CRUD-API","version":"1.0.0"}}")
70-
- "cacheType": "TempFile" (default), "Redis", "Memcache", "Memcached" or "NoCache"
67+
- "middlewares": List of middlewares to load ("`cors`")
68+
- "controllers": List of controllers to load ("`records,openapi`")
69+
- "openApiBase": OpenAPI info ("`{"info":{"title":"PHP-CRUD-API","version":"1.0.0"}}`")
70+
- "cacheType": "`TempFile`" (default), "`Redis`", "`Memcache`", "`Memcached`" or "`NoCache`"
7171
- "cachePath": Path/address of the cache (defaults to system's "temp" directory)
72-
- "cacheTime": Number of seconds the cache is valid (10)
73-
- "debug": Show errors in the "X-Debug-Info" header (false)
72+
- "cacheTime": Number of seconds the cache is valid ("`10`")
73+
- "debug": Show errors in the "X-Debug-Info" header ("`false`")
7474

7575
## Compilation
7676

77-
The code resides in the "src" directory. You can access it at the URL:
77+
The code resides in the "`src`" directory. You can access it at the URL:
7878

7979
http://localhost:8080/src/records/posts/1
8080

81-
You can compile all files into a single "api.php" file using:
81+
You can compile all files into a single "`api.php`" file using:
8282

8383
php build.php
8484

0 commit comments

Comments
 (0)