Browse Source

doc: usage

pull/13/head
oof1lab 7 years ago
parent
commit
5811ca11ea
  1. 18
      README.md

18
README.md

@ -6,14 +6,23 @@
# xmysql: one command to generate REST APIs for **any** MySql database # xmysql: one command to generate REST APIs for **any** MySql database
## Why this ? ## Why this ?
<p align="center">
<img src="https://media.giphy.com/media/8gWrk3QZrjF1C/giphy.gif" alt="Rick & Morty"/>
</p>
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 ..
Hence this.
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"> <p align="center">
<img src="https://media.giphy.com/media/8gWrk3QZrjF1C/giphy.gif" alt="Rick & Morty"/> <img src="https://media.giphy.com/media/xUOxf88tjN0AN7uUfu/source.gif" alt="xmysql gif"/>
</p> </p>
Hence this.
Powered by node packages : ([express](https://github.com/expressjs/express), [mysql](https://github.com/mysqljs/mysql)) => { [xmysql](https://github.com/o1lab/xmysql) } Powered by node packages : ([express](https://github.com/expressjs/express), [mysql](https://github.com/mysqljs/mysql)) => { [xmysql](https://github.com/o1lab/xmysql) }
@ -31,11 +40,6 @@ 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

Loading…
Cancel
Save