Update README.md

Author: Pranjal Pandey

README.md

@@ -1,2 +1,76 @@
-# php2js
- convert php code to javascript code that run on browser
+# PIQON PHP2JS
+Convert php code to javascript code that can run on browser
+
+### Installation 
+package can be installed via composer<br>
+```
+composer require piqon/php2js
+```
+
+### Usage
+If You want to create a copiled javascript file , you can run the following code: <br>
+
+```php
+<?php
+include __DIR__ . '/vendor/autoload.php';
+
+/*
+* Replace test.php with path of your input php file
+* Replace test.js with path for your js file output
+*/
+
+\PHP2JS\PHP2JS::compileFile(__DIR__.'/test.php',__DIR__.'/test.js');
+```
+
+If you just want to convert a small block of code , you can run the following code:
+
+```php
+<?php
+include __DIR__ . '/vendor/autoload.php';
+
+$code = "
+$name='1';
+echo 'hi'; 
+"
+
+\PHP2JS\PHP2JS::compile($code);
+```
+
+### Demo
+
+Input code :
+
+```php
+<?php
+$name = 'Pranjal';
+$cars = ['BMW','Audi'];
+$cars->push('Ferrari');
+echo $name;
+echo $cars;
+
+function click(){
+    echo 'button clicked!';
+}
+```
+
+Output code:
+```javascript
+
+let name = 'Pranjal';
+let cars = ['BMW', 'Audi'];
+cars.push('Ferrari');
+console.log( name);
+console.log( cars);
+
+function click()
+{
+    console.log( 'button clicked!');
+}
+
+```
+
+
+### Note
+This was designed to convert php scripts to javascript code , this might not work with full blown php classes !
+You can call javascript functions like console.log etc right from your php code and it will work as expected in the browser.
+This compiler does not support magic variables and magic functions of PHP.