Browse Source

doc: usage

pull/13/head
oof1lab 7 years ago
parent
commit
dc321177b7
  1. 11
      README.md

11
README.md

@ -5,11 +5,6 @@
# xmysql: one command to generate REST APIs for **any** MySql database # xmysql: one command to generate REST APIs for **any** MySql database
<p align="center">
<img src="https://media.giphy.com/media/xUOxf88tjN0AN7uUfu/source.gif" alt="xmysql gif"/>
</p>
## Why this ? ## Why this ?
Generating REST APIs quickly for a MySql database which does not follow conventions of Generating REST APIs quickly for a MySql database which does not follow conventions of
frameworks such as rails, django etc is a small adventure that one rather like to avoid .. frameworks such as rails, django etc is a small adventure that one rather like to avoid ..
@ -36,6 +31,12 @@ http://localhost:3000
That is it! Happy hackery! That is it! Happy hackery!
eg: Generate REST API for [Magento](http://www.magereverse.com/index/magento-sql-structure/version/1-7-0-2) - a [popular ecommerce platform](https://magento.com/)
<p align="center">
<img src="https://media.giphy.com/media/xUOxf88tjN0AN7uUfu/source.gif" alt="xmysql gif"/>
</p>
## Features ## Features
* Generates API for **ANY** MySql database * Generates API for **ANY** MySql database
* Serves APIs irrespective of naming conventions of primary keys, foreign keys, tables etc * Serves APIs irrespective of naming conventions of primary keys, foreign keys, tables etc

Loading…
Cancel
Save