Fixing comments

Author: BreadEaterYT

README.md

@@ -4,17 +4,24 @@ JavaPHP is a lightweight Java library that permits to execute PHP code into Java
 you can just use PHP and execute it as a part of your existing Java code, does not rely on any dependencies, its fully standalone,
 and you can use it in a compiled .jar file or in a simple .java file without having to compile it
 
+Fun fact: this library was made in like 1 day because i had no other ideas and i was bored so yeah, now this library exists.
+
 ### Features
 - PHP file execution in java
 - Customizable error handling
 
+There are not alot of features because i keep it very simple, why would i do a lot of features since its focused only on the purpose of executing PHP in Java.
+
 ### How to use
 Simply import it to your file and do like this:
+
 ```java
 import java.io.File;
 import java.util.HashMap;
 import java.util.Map;
 
+import fr.breadeater.JavaPHP;
+
 public class Main {
     public static void main(String[] args) throws Throwable {
         JavaPHP javaphp = new JavaPHP(false);
@@ -33,10 +40,8 @@ public class Main {
 ```
 
 ### Installation
-Simply download the .jar / .java file from the repository Releases and import it in your project
-
-To import the .java file, simply drag it into your project folder.<br>
-To import the .jar file, simply use Maven / Gradle and add new dependency to your configuration that points to the .jar file
+Simply download the .jar / .java file from the repository Releases and import it in your project.<br>
+For Maven or Gradle, add it to your local repository.
 
 ### Contribution
 You can contribute as much as you want, the conditions: 
@@ -50,5 +55,4 @@ You can contribute as much as you want, the conditions:
 You can contact me via [mail](mailto:contact@breadeater.fr) or send message in the discussions of the repository
 
 ### License
-
 This project is licensed under the MIT license, see [LICENSE](./LICENSE) for more infos.

pom.xml

@@ -21,7 +21,7 @@
                 <configuration>
                     <archive>
                         <manifest>
-                            <mainClass>fr.breadeater.Main</mainClass>
+                            <mainClass>fr.breadeater.JavaPHP</mainClass>
                         </manifest>
                     </archive>
                     <descriptorRefs>

src/main/java/fr/breadeater/JavaPHP.java

@@ -6,25 +6,26 @@
 import java.util.function.Consumer;
 
 public class JavaPHP {
+    private Consumer<String> ERR_CALLBACK;
+
     private final String PHP_BIN_PATH;
     private final boolean NO_PHP_WARN;
 
     private Map<String, String> env_vars;
     private String response = null;
 
-    private Consumer<String> ERR_CALLBACK;
-
     /**
-     * Creates a PHPJava instance
+     * Creates a JavaPHP instance
      * @param php_bin_path PHP binary file path (e.g /usr/bin/php)
+     * @param ignorePHPWarnings Specifies if PHP Warning and PHP Startup errors should be ignored
      */
     public JavaPHP(String php_bin_path, boolean ignorePHPWarnings){
         this.PHP_BIN_PATH = php_bin_path;
         this.NO_PHP_WARN = ignorePHPWarnings;
     }
 
     /**
-     * Creates a PHPJava instance
+     * Creates a JavaPHP instance
      * @param ignorePHPWarnings Specifies if PHP Warning and PHP Startup errors should be ignored
      */
     public JavaPHP(boolean ignorePHPWarnings){
@@ -33,7 +34,7 @@ public JavaPHP(boolean ignorePHPWarnings){
     }
 
     /**
-     * Creates a PHPJava instance
+     * Creates a JavaPHP instance
      */
     public JavaPHP(){
         this.PHP_BIN_PATH = "php";
@@ -43,8 +44,9 @@ public JavaPHP(){
     /**
      * Sets PHP global variables like REQUEST_METHOD, REQUEST_ADDR, etc...<br>
      * See <a href="https://www.php.net/manual/en/reserved.variables.php">PHP global variables</a> for other examples.<br><br>
-     *
      * WARNING: THIS IS REQUIRED IF USING $_SERVER VARIABLES OR OTHERS !
+     *
+     * @param variables The PHP global variables
      */
     public void setPHPVars(Map<String, String> variables){
         this.env_vars = variables;

src/main/java/fr/breadeater/Main.java

@@ -10,7 +10,6 @@
 
 public class Main {
     public static void main(String[] args) throws Throwable {
-        /*
         JavaPHP javaphp = new JavaPHP(false);
         Map<String, String> env = new HashMap<>();
 
@@ -22,6 +21,5 @@ public static void main(String[] args) throws Throwable {
         javaphp.run(new File("./test.php").getAbsolutePath());
 
         System.out.println(javaphp.getResult());
-        */
     }
 }