Skip to content

Commit 9b15335

Browse files
committed
Spellcheck
1 parent cff6156 commit 9b15335

File tree

1 file changed

+17
-16
lines changed

1 file changed

+17
-16
lines changed

README.md

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -38,38 +38,39 @@ codebase-root/
3838

3939
#### Explanation of the listed files:
4040

41-
- `codebase-root/` is the root directory of the codebase. Choose any directory.
41+
- `codebase-root/` This is the root directory of the codebase. (Choose any directory).
4242

43-
- `codebase-root/api-funcs-base/` is the directory where all the API definitions are stored.
44-
*Directory name does not need to be `api-funcs-base`. It can be anything.*
43+
- `codebase-root/api-funcs-base/` This is the directory where all the API definitions are stored.
44+
(Directory name does not need to be `api-funcs-base`. It can be anything.)
4545

46-
- `@all.php` [Optional] is the file that is called for all the functions in this directory ***and its subdirectories***.
46+
- `@all.php` [Optional] This file is executed before all the APIs in this directory **and its subdirectories**.
4747

48-
- `@index.php` [Optional] File that defines the api available at https://api.sample.dev
48+
- `@index.php` [Optional] This file defines the API available at https://api.sample.dev
4949

50-
- `Ping.php` is the file that defines the api available at https://api.sample.dev/ping
50+
- `Ping.php` This file defines the API available at https://api.sample.dev/ping
5151

52-
- `Example/` is a directory that contains more API functions.
52+
- `Example/` This directory contains all APIs grouped under 'example' API.
5353

54-
- `@all.php` [Optional] is the file that is called for all the functions in this directory ***and its subdirectories***.
54+
- `@all.php` [Optional] This file is executed before all the APIs in this directory **and its subdirectories**.
5555

56-
- `@index.php` [Optional] File that defines the api available at https://api.sample.dev/example
56+
- `@index.php` [Optional] This file defines the API available at https://api.sample.dev/example
5757

58-
- `Adder.php` is the file that defines the api available at https://api.sample.dev/example.adder
58+
- `Adder.php` This file defines the API available at https://api.sample.dev/example.adder
5959

60-
- `CamelCase/` is a directory that contains more API functions.
60+
- `CamelCase/` This directory contains all APIs grouped under 'example.camel_case' API.
6161

62-
- `@index.php` [Optional] File that defines the api available at https://api.sample.dev/example.camel_case
62+
- `@index.php` [Optional] This file defines the API available at https://api.sample.dev/example.camel_case
6363

64-
- `Hello.php` is the file that defines the api available at https://api.sample.dev/example.camel_case.hello
64+
- `Hello.php` This file defines the API available at https://api.sample.dev/example.camel_case.hello
6565

6666

67-
- `codebase-root/public/` is the public directory where the server is running.
67+
- `codebase-root/public/` This is the public directory where the server is running.
68+
(i.e. https://api.sample.dev must point to this directory.)
6869
*Directory name does not need to be `public`. It can be anything.*
6970

70-
- `.htaccess` is the file that redirects all requests to `index.php`.
71+
- `.htaccess` This file is used to rewrite the URLs to the API framework.
7172

72-
- `index.php` is the file that initializes the API framework.
73+
- `index.php` This file is the entry point of the server.
7374

7475

7576

0 commit comments

Comments
 (0)