update readme

README.md

@@ -1,5 +1,16 @@
 # enowars8-service-piratesay
 
+### Testing out the service
+
+1. Clone the repo and run docker compose up for the both service and checker (use the local compose for the checker)
+2. Run service/src/generate_content.py to get a clean start
+3. Run the checker, put in a flag and check that it is "gettable". Maybe also check that the exploit works for good measure
+   1. `enochecker_cli -A http://localhost:5008/ -a piratesay -f ENOFLAGENOFLAG=12345 putflag`
+   2. `enochecker_cli -A http://localhost:5008/ -a piratesay -f ENOFLAGENOFLAG=12345 getflag`
+   3. `enochecker_cli -A http://localhost:5008/ -a piratesay -f ENOFLAGENOFLAG=12345 --flag_regex ENOFLAGENOFLAG=.+ exploit`
+4. Connect to the service with `telnet localhost 4444` and start hunting for the exploit ;)
+5. For the solution and more detailed info about the application, look at the readme in the documentation folder
+
 ### TODO
 
 - [x] Change name of service and commands in command line. This will also somewhat help even out between beginners and advanced players, novel for both.

documentation/README.md

@@ -1,6 +1,6 @@
-# Pirate Prattle
+# Pirate Say
 
-Pirate Prattle is a TCP-server written in C that presents itself as a pirate-themed dark web forum service. The service contains various logs dictating/accounting the achievements of scammers. The service contains the following file types:
+Pirate Say is a TCP-server written in C that presents itself as a pirate-themed dark web forum service. The service contains various logs dictating/accounting the achievements of scammers. The service contains the following file types:
 
 - .log files: these are standard log files without any password protection
 - .treasure files: these files are protected by a password input that contain a format string vulnerability