Merge branch 'main' of https://github.com/markjivko/php-sandbox

Author: markjivko

README.md

@@ -1,19 +1,13 @@
 # PHP Sandbox
 
-<p align="center">
-   <a href="https://github.com/markjivko/php-sandbox/blob/main/assets/preview.gif">
-      <img src="https://repository-images.githubusercontent.com/460528694/c41b4a49-c4de-42a4-a8ea-18a7f80bef0e"/>
-   </a>
-</p>
+This is a tiny PHP sandbox powered by Docker and [Ace editor](https://github.com/ajaxorg/ace).
 
-This is a tiny PHP sandbox powered by Docker and Ace editor.
+Use it for quick tests, pair programming or even online interviews.
 
 <a href="https://github.com/markjivko/php-sandbox/blob/main/assets/preview.gif">
    <img src="https://github.com/markjivko/php-sandbox/blob/main/assets/preview.gif?raw=true"/>
 </a>
 
-Use it for quick tests, pair programming or even online interviews.
-
 ## How to install
 
 1. First install the **LAMP** stack (Apache, MySQL, PHP)
@@ -37,18 +31,30 @@ This is by design:
  * The only way to create new pages is to manually add text files in `/var/www/html/code/`
  * In order to make pages editable, manually change their permission to `666` (via cli or UI)
 
-There is only 1 page available when you install this script, `two-sum.txt`;
+There is only 1 page available when you install this script, `two-sum.txt`.
  * In order to view it, open a browser at `http://localhost/two-sum/`
- * Make it editable with `sudo chmod 666 /var/www/html/code/two-sum.txt` or directly from your favorite file explorer
+ * Make it editable with `chmod 666 /var/www/html/code/two-sum.txt` or directly from your favorite file explorer
 
 3. Last but not least, [install **Docker**](https://docs.docker.com/engine/install/ubuntu/)
 
 ## Security
 
-The project is read-only for Apache with the expection of text files you selected.
+The project is read-only for Apache with the exception of text files you selected.
 
 Your text files are executed with PHP only inside of a Docker container.
+
 * the container has read-only access to `/var/ww/html/code` only
 * the script is killed automatically after 3 seconds
+* script output is limited to 4096 bytes
+
+## Improvements
+
+The current version uses a basic state machine to check for changes and regularly fetch updates.
+
+Websockets could be used to make the typing experience more fluid for all parties involved.
+
+The app is intentionally bare-bones. There are no users/roles/databases to worry about; you just manually add text files in `/var/www/html/code/` and set their permissions accordingly. 
 
-You can safely run this script on your laptop (with correct port forwarding).
+> Simplicity is the ultimate sophistication.
+> 
+> -- Leonardo Da Vinci