diff --git a/README.md b/README.md index 6fd6f917db..0f94e8ceb9 100644 --- a/README.md +++ b/README.md @@ -3,22 +3,17 @@ [![GitHub stars](https://img.shields.io/github/stars/o1lab/xmysql.svg?style=plastic)](https://github.com/o1lab/xmysql/stargazers) [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/o1lab/xmysql/master/LICENSE) -

- XMYSQL -

-

- One command to generate REST APIs for any MySql database -

- -
-
- -#### Example : Generating REST APIs for [Magento Mysql Database](http://www.magereverse.com/index/magento-sql-structure/version/1-7-0-2) - popular E-commerce platform +# xmysql : One command to generate REST APIs for any MySql database +Powered by popular node packages : ([express](https://github.com/expressjs/express), [mysql](https://github.com/mysqljs/mysql)) => { [xmysql](https://github.com/o1lab/xmysql) } +# Why this ?

xmysql gif

+Generating REST APIs for a MySql database which does not follow conventions of +frameworks such as rails, django etc is a small adventure that one like to avoid .. + # Setup and Usage ``` npm install -g xmysql @@ -29,11 +24,15 @@ xmysql -h localhost -u mysqlUsername -p mysqlPassword -d databaseName ``` http://localhost:3000 ``` - That is it! Happy hackery! -Powered by node packages : ([express](https://github.com/expressjs/express), [mysql](https://github.com/mysqljs/mysql)) => { [xmysql](https://github.com/o1lab/xmysql) } +# Example : Generating REST APIs for [Magento DB](http://www.magereverse.com/index/magento-sql-structure/version/1-7-0-2) +[Magento](https://magento.com/) is a popular E-commerce platform + +

+ xmysql gif +

# Features