cleaned up files and updated README

Signed-off-by: xenthy <[email protected]>

Author: xenthy

Makefile

@@ -20,8 +20,8 @@ check:
 	$(CC) $(FLAGS) $(TARGET)
 
 docker:
-	docker build -t ict2206:latest .
-	docker run -ti ict2206
+	docker build -t emoji-web-server:latest .
+	docker run -ti emoji-web-server
 
 dockerclean:
 	docker system prune -a
@@ -32,7 +32,7 @@ ifeq ($(OS),Windows_NT)
 	@powershell "(Get-ChildItem * -Include *.o -Recurse | Remove-Item)"
 	@echo Cleaned up ./src/main & *.o files
 else
-	@echo "Cleaning up [.pyc, __pycache__, apktool/, junk apk] files..."
+	@echo "Cleaning up [main, .o, compiled] files..."
 	@find ./src -type f -name "$(OUT)" -exec rm -f {} +
 	@find . -type f -name "*.o" -exec rm -f {} +
 	@find . -type f -name "*.emojic_original" -exec rm -f {} +

README.md

@@ -1 +1,35 @@
-# ict2206-assignment-2
+# emojicode-web-server
+
+## Setting Up
+1. Build/Install dependencies
+```console
+➜ cd emojicode-web-server
+➜ ./configure
+```
+
+## Running Project using Make
+1. To run the program
+```console
+➜ make
+```
+2. To clean compiled files (main, .o, compiled)
+```console
+➜ make clean
+```
+
+## Running Project using Docker
+```console
+➜ make docker
+```
+
+## Configurations
+- Listening Port: `8888`
+- Web Root: `/var/www/emoji/html`
+- Default Page: `index.html`
+- No. of Workers: `512`
+
+## Limitations
+- Can only serve GET requests..for now
+- Supports HTTP/1.1 & below
+- Pages not cached to RAM unlike Apache, nginx
+- No config file