Skip to content

Commit 4201854

Browse files
authored
Update README.md
1 parent f7928b1 commit 4201854

File tree

1 file changed

+20
-2
lines changed

1 file changed

+20
-2
lines changed

README.md

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,24 @@
11
# db-class
22
This project is a simple database class with php and pdo.
33

4+
## Table of Contents
5+
1. [Installation/Setup](#installationsetup)
6+
2. [Basic Usage](#basic-usage)
7+
1. [Require Database Class](#require-database-class)
8+
2. [Instantiate Class / Connect to Database (`__construct()`)](#instantiate-class--connect-to-database-__construct)
9+
3. [Check Connection to Database (`connected()`)](#check-connection-to-database-connected)
10+
4. [Select/Get Data from Database (`select()`)](#selectget-data-from-database-select)
11+
5. [Insert Data into Database (`insert()`)](#insert-data-into-database-insert)
12+
6. [Delete Data/Rows from Database (`delete()`)](#delete-datarows-from-database-delete)
13+
7. [Update Data in Database (`update()`)](#update-data-in-database-update)
14+
8. [Configure Error Handling (`initErrorHandler()`)](#configure-error-handling-initerrorhandler)
15+
9. [Check for Errors (`error()`)](#check-for-errors-error)
16+
10. [Get Errors (`getError()`)](#get-errors-geterror)
17+
3. [Further Examples / Stuff for Testing](#further-examples--stuff-for-testing)
18+
4. [Contributing](#further-examples--stuff-for-testing)
19+
5. [Versioning](#versioning)
20+
6. [License](#license)
21+
422
## Installation/Setup
523
If you want to use the database class for your own project, you can simply follow these instructions:
624

@@ -11,12 +29,12 @@ If you want to use the database class for your own project, you can simply follo
1129
## Basic Usage
1230
If you have successfully "installed" everything, you can use the class like that:
1331

14-
### Require database class
32+
### Require Database Class
1533
```php
1634
require_once('your_path/DB.php');
1735
```
1836

19-
### Instantiate Class / Connect to Database (`__construct`)
37+
### Instantiate Class / Connect to Database (`__construct()`)
2038
To be able to use the class and connect to the database, you have to instantiate it.
2139

2240
To do that, follow that format:

0 commit comments

Comments
 (0)