diff --git a/README.md b/README.md index 9dcfe2f..1bcc555 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ # SORM ## Description -SORM stands for SQL ORM. I made this because i have a hate/love relationship with both. I combined it together to have the best of both worlds! +SORM stands for SQL ORM. I made this because I have a love/hate relationship with both. I combined them together to have the best of both worlds! -The naming of my functions and variables are something to get used to. They're all abbreviations, kinda like C stdlib style. It looks weird, but you get used to it quickly and in reality, you just use a few of them. +The naming of my functions and variables are something to get used to. They are all abbreviations, kinda like C stdlib style. It looks weird, but you get used to it quickly and in reality, you just use a few of them. Examples of common used functions are: - `sormc(char *path)` connect to database. Returns `int`. @@ -14,7 +14,7 @@ Examples of common used functions are: I wonder if I have configured sqlite3 the right way for thread safety. It maybe requires a manual compilation of the shared object file. Will look into that. SORM is written with thread safety in mind. ## Design choices -I use mainly native types and not custom structs. For example, the db parameter is an int. This is so it can easily conmmunicate with other languages using a shared object file. +I use mainly native types and not custom structs. For example, the db parameter is an int. This is so it can easily communicate with other languages using a shared object file. Same argument is for the result set of `sormq` (the query function) resulting in a `char *` containing CSV data. While the performance is nice, it's not written with performance in mind at all. @@ -63,4 +63,3 @@ Yes, you did see that right, you can use the default native free! sormd(db); ``` -