From 958965b7f66d92e765cda9e4b0d4f236adc45df4 Mon Sep 17 00:00:00 2001 From: oof1lab Date: Sun, 12 Nov 2017 11:15:15 +0530 Subject: [PATCH] doc: update --- README.md | 35 +++++++++++++++++++---------------- 1 file changed, 19 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index fdc9abad96..aa01d4687d 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,9 @@ # Xmysql : One command to generate REST APIs for any MySql database +
+ + # Why this ?

xmysql gif @@ -15,6 +18,8 @@ frameworks such as rails, django, laravel etc is a small adventure that one like Hence this. +

+ # Setup and Usage ``` @@ -58,22 +63,20 @@ Powered by popular node packages : ([express](https://github.com/expressjs/expre # Features -* Rest API Usual Suspects - * CRUD, List, Count, Exists - * Relations - * Pagination - * Sorting -* Xmysql Rest API - :tada: :snowboarder: :crystal_ball: :tophat: :santa: - * Generates API for **ANY** MySql database - * Serves APIs irrespective of naming conventions of primary keys, foreign keys, tables etc - * Support for composite primary keys - * Column filtering - Fields - * Row filtering - Where - * Group By, Having (as query params) - * Group By, Having (as a separate route) - * Aggregate functions - * Union of many group by statements :fire::fire: **[ HOTNESS ALERT ]** -* Prototyping (features available with only local MySql server) +* Generates API for **ANY** MySql database +* Serves APIs irrespective of naming conventions of primary keys, foreign keys, tables etc +* Support for composite primary keys +* CRUD, List, FindOne, Count, Exists +* Relations +* Pagination +* Sorting +* Column filtering - Fields +* Row filtering - Where +* Group By, Having (as query params) +* Group By, Having (as a separate route) +* Aggregate functions +* Union of many group by statements :fire::fire: **[ HOTNESS ALERT ]** +* Prototyping (features available with ONLY local MySql server) * Run dynamic queries * Upload single file * Upload multiple files