Skip to content

Commit e13a4a5

Browse files
authored
Update README.md
1 parent df331cf commit e13a4a5

File tree

1 file changed

+14
-4
lines changed

1 file changed

+14
-4
lines changed

README.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Yazan - SQLToCIBuilder
1+
# Yazan - SQL-To-CI-Builder
22
SQL to Codeigniter Query Builder, A Converter written in PHP
33

44
### Features
@@ -81,13 +81,23 @@ Some important options are briefly explained below:
8181
| single_line | boolean | true | When this argument is true, then converter tries to generate a single command instead of multiple. |
8282

8383
### How does it works ?
84-
Will be explained soon.
84+
SQL-To-CI-Builder is built on top of <a href="hhttps://github.com/greenlion/PHP-SQL-Parser">PHP-SQL-Parser</a>. While <a href="hhttps://github.com/greenlion/PHP-SQL-Parser">PHP-SQL-Parser</a> is responsible for parsing the given SQL Query as input. The result of the <a href="hhttps://github.com/greenlion/PHP-SQL-Parser">PHP-SQL-Parser</a> is the input of SQL-To-CI-Builder.
85+
86+
The structure has three main parts :
87+
1) Extractors classes - which help to pull out SQL Query parts in a way which are more understandable and processable by Builders.
88+
2) Builder classes - which help to construct Query Builder methods.
89+
3) Creator - which orchestrates the process between Extractors and Builders in order to produce parts of Query Builder.
8590

8691
### Known issues
87-
Will be explained soon.
92+
It is not tested in all cases. They should be added.
93+
Poor error handling.
94+
95+
96+
### Contributions
97+
Feel free to contribute. Either on development or testing.
8898

8999
### Support
90-
For general questions about Yazan - SQLToCIBuilder, tweet at @rexshijaku or write me an email on rexhepshijaku@gmail.com.
100+
For general questions about Yazan - SQL-To-CI-Builder, tweet at @rexshijaku or write me an email on rexhepshijaku@gmail.com.
91101
To have a quick tutorial check the examples folder provided in the repository.
92102

93103
### Author

0 commit comments

Comments
 (0)