Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
puritys committed Dec 30, 2016
1 parent 877c5b7 commit 52c5375
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ Chinese Readme: https://github.com/puritys/nodejs-phplike/wiki/%E4%B8%AD%E6%96%8

This project's purpose is to provider some PHP synchronous functions for the web development on Node.js.

Node.js is a event-driven language and it has many asynchronous I/O methods. Asynchronous functions is not a bad way for a web system, it help us to develop a non-blocking I/O program. But sometimes, we want to make code readable and easier to be maintained that asynchronous functions don't have them.
Node.js is a event driven language and it has many asynchronous I/O methods. Asynchronous functions is not a bad way for a web system, it helps us to develop a non-blocking I/O program. But sometimes, we want to make code readable and easier to be maintained that asynchronous functions don't have them.

In order to reduce the number of callback functions on Node.js scripts and improve the readability. I create the library phplike which supports many synchronous functions for Node.js such as "exec", "curl", "fsockopen" that can be executed without complicated callback functions. In additional, phplike provides the function cUrl which has the same operations with PHP's function called curl. It will let you make a HTTP request synchronously.
In order to reduce the number of callback functions on Node.js scripts and improve the readability. I create the library phplike which supports many synchronous functions for Node.js such as "exec", "curl", "fsockopen" that can be executed without complicated callback functions. In additional, phplike provides the function cUrl which has the same operations with PHP's function called curl. It will let you make an HTTP request synchronously.


* npm: https://npmjs.org/package/phplike
Expand All @@ -25,7 +25,7 @@ Travis CI status: [![Unit testing](https://travis-ci.org/puritys/nodejs-phplike.

* sudo npm install -g phplike

If your computer is not a normal OS, and it doesn't have the header files of Curl, You will need to install node-gyp first. The installation of phplike library will compile the C/C++ code with node-gyp. Usually, NPM will automatically install node-gyp when you try to install phplike. Or you can install node-gyp by yourself.
If your computer is not a normal OS, and it doesn't have the header files of Curl, You will need to install node-gyp first. The installation of the phplike library will compile the C/C++ code with node-gyp. Usually, NPM will automatically install node-gyp when you try to install the phplike. Or you can install node-gyp by yourself.

* sudo npm install -g node-gyp

Expand All @@ -37,9 +37,9 @@ If your computer is not a normal OS, and it doesn't have the header files of Cur

How many OS does phplike support?
---------------------------
* Linux : Every version of phplike support linux systems.
* Mac : Supported from phplike@2.0.5 to latest
* Windows: Only the following version are supported: phplike@2.1.0 、 phplike@2.2.8 , phplike@2.4.4 . I have tested features of phplike on windows 8 and windows xp.
* Linux: Every version of the phplike support Linux systems.
* Mac: Supported from phplike@2.0.5 to latest
* Windows: Only the following version are supported: phplike@2.1.0 、 phplike@2.2.8 , phplike@2.4.4 . I have tested features of the phplike on windows 8 and windows XP.
* Raspberry PI (Pidora OS with ARM CPU): phplike@2.2.2 ~ Latest

| OS | Suggested phplike Version |
Expand All @@ -53,8 +53,8 @@ If you have any issue for installing phplike, please open a issue in anytime. I

Dependency
-----------
* Phplike have been already tested in Node.js version from 0.10.x to 0.12.x and io.js 1.0.0 to 2.1.0. Here is the test report : https://travis-ci.org/puritys/nodejs-phplike
* libcurl (libcurl-7.19) : Linux system already have this built-in package. Please install libcurl-devel : sudo yum install libcurl-devel
* Phplike have been already tested in Node.js version from 0.10.x to 0.12.x and io.js 1.0.0 to 2.1.0. Here is the test report: https://travis-ci.org/puritys/nodejs-phplike
* libcurl (libcurl-7.19) : Linux system already has this built-in package. Please install libcurl-devel : sudo yum install libcurl-devel
* python 2.4 ~ : phplike use node-gyp to compile C/C++ codes. It needs python with the version must be bigger than 2.7.8 , you can download python from here https://www.python.org/downloads/.

After the new version of phplike 2.2.0, I committed all binary files which already compiled in Windows, Mac and Linux, you can just install the phplike without compiling C/C++ now.
Expand Down Expand Up @@ -162,7 +162,7 @@ Completed PHP Method
Execute phplike in global mode sample
-------------------------------

You can directly use the phplike functions. The functions of phplike are defined at the global object when you require the index.js. It means that you don't need the prefix before calling the phplike's function. The Node.js coding will be more like PHP's. The only one disadvantage is that defining a function at global object is easier to meet the conflict problem.
You can directly use phplike functions. Functions of phplike are defined at the global object when you require the index.js. It means that you don't need the prefix before calling the phplike's function. The Node.js coding will be more like PHP's. The only one disadvantage is that defining a function at the global object is easier to meet the conflict problem.

exec(command, printInScreen = true);

Expand All @@ -178,7 +178,7 @@ Execute phplike in module mode sample (phplike 2.0)
----------------------------------------------


You can require the module.js of phplike, it will return the Phplike object. This object includes many functions of PHP for you to use at anytime. The module mode will not change the methos of global object so it won't be conflict with other Node.js native functions.
You can require the module.js of phplike, it will return the Phplike object. This object includes many functions of PHP for you to use at any time. The module mode will not change methods of the global object so it won't be a conflict with other Node.js native functions.

```
var php = require("phplike/module.js");
Expand Down

0 comments on commit 52c5375

Please sign in to comment.