Added readme.md

readme.md

@@ -0,0 +1,133 @@
+# GoJump, the Offline Rocket-jumper Speedrun Time tracking tool
+
+Do you want to jump offline but still keep track of all your map-times? Do you hate exel spreadsheets and having to manually update and keep track of each value?
+
+GoJump can help you out! by tracking the difficulty of maps, you can effecively select a map to play, get your time if you have one. record the time seperately, and submit new times to be updated and kept track of. 
+We even have previous runs being tracked! 
+
+
+Be the best Source Engine player with the godliest Movement, and train yourself today with this amazing tool <3  
+  
+  
+### Example Usage: 
+Listing out maps  
+```
+[]$ sh gojump.sh list-maps | head -n5
+Found maps:
+jump_
+jump_4dakids_final
+jump_4demo_fixed5
+jump_4holers_fix
+```
+  
+Getting the tiers of maps as different Classes
+```
+[]$ sh gojump.sh list-tier mireal_tpn d
+jump_mireal_tpn: T6
+[]$ sh gojump.sh list-tier mireal_tpn s
+jump_mireal_tpn: T1
+```
+  
+Similar Map-name Resolution
+``` 
+[]$ sh gojump.sh list-tier mireal d
+There are too many maps that match your request: "jump_mireal"
+The following maps match your request:
+database/map_info/jump_mireal2_final.json
+database/map_info/jump_mireal3_final.json
+database/map_info/jump_mireal_tpn.json
+exit status 2
+```
+   
+Just give me a neat map to play
+```
+[]$ sh gojump.sh list-handful s
+Found list of maps to complete:
+jump_virtuoso_tpn: T3
+jump_rook_beta: Slowest Completed: 2023-08-28/08:32 in 0h 52m 7s
+jump_rnc_a1: T4
+jump_momentum: Oldest Completed: 2023-05-22/14:18 in 0h 9m 33s
+jump_vertigo: T3
+jump_grotto_rc2: Oldest Completed: 2023-02-01/16:41 in 0h 6m 23s
+jump_vape_rc3: T3
+jump_arctic_a2: T3
+jump_pagoda: T3
+jump_something_rc1_fix_v2: T4
+jump_benny: Slowest Completed: 2023-11-06/18:50 in 0h 54m 12s
+jump_demonstrationman_a4: T1
+jump_impact: Oldest Completed: 2023-06-10/16:02 in 0h 8m 3s
+```
+
+List maps completed recently 
+```
+[]$ sh gojump.sh list-recently-completed-times
+Warning: No classname provided, using soldier as default
+Recently Completed Maps:
+jump_flashblack: Completed: 2024-06-03/13:23 in 0h 6m 40s
+jump_dreamy_final: Completed: 2024-05-23/10:37 in 0h 23m 43s
+jump_depleted: Completed: 2024-05-22/18:43 in 0h 30m 1s
+jump_kinetics_c1: Completed: 2024-05-14/13:14 in 0h 10m 34s
+jump_elephant_a2: Completed: 2024-05-14/12:27 in 0h 3m 14s
+jump_deserted_b1: Completed: 2024-05-04/19:04 in 0h 14m 5s
+jump_canyon_b1: Completed: 2024-04-30/12:29 in 0h 5m 47s
+```
+  
+Are you forgetting about maps?  
+Check your Oldest completed maps and update the time with a new one! You need to be faster than before tho so GL !!!
+```
+[]$ sh gojump.sh list-few-old-completed-times s
+Oldest Completed Maps:
+jump_tesseract_fix_v2: Completed: 2023-01-14/14:58 in 0h 18m 24s
+jump_grotto_rc2: Completed: 2023-02-01/16:41 in 0h 6m 23s
+jump_concrete_rc1: Completed: 2023-02-01/18:15 in 0h 16m 6s
+jump_booyah_jmc: Completed: 2023-02-04/16:38 in 0h 5m 22s
+jump_duality_tpn: Completed: 2023-02-07/12:27 in 0h 8m 8s
+jump_mhx_b1: Completed: 2023-02-10/07:12 in 0h 6m 54s
+jump_if_rc2: Completed: 2023-02-10/13:22 in 0h 3m 16s
+```
+  
+What maps did you not complete? (these are all going to be high tiers usually, pipe the output into Grep and you will be pleased to see only specific tiers that you want)
+```
+[]$ sh gojump.sh list-uncompleted-tiers s
+Found uncompleted map tiers:
+jump_: T5
+jump_4dakids_final: T5
+jump_4demo_fixed5: T4
+jump_4holers_fix: T6
+jump_aando_b1_tmps: T6
+jump_abandon: T4
+```
+
+## Help 
+```
+[]$ sh gojump.sh help
+usage: gojump.sh [operation] <Additional Args>
+try running "gojump.sh help" for additional info on operations
+
+help - Get the help you are currently seeing
+list-maps - Get a list of all maps available
+get-curtime - Get the current unix date, time in seconds, for use in storing times in the database
+convert-time - Convert a time from HH:MM:SS.MS to seconds, for use in storing times in the database
+
+usage: gojump.sh [operation] <MAP_NAME> <SOLDIER/DEMOMAN(s/d)>
+get-time - Get a personal maps completion time
+list-tier - Get the difficulty tier of a particular map
+
+usage: gojump.sh [operation] <SOLDIER/DEMOMAN(s/d)>
+list-tiers - Get all of the difficulty tiers listed out, useful for combining with grep!
+list-completed-tiers - List out personal completed maps with their tiers
+list-uncompleted-tiers - List out personal unbeaten maps with their tiers, useful for combining with grep!
+list-completed-times - Lists out the completed maps with their times sorted by the time with newest first.
+list-old-completed-times - Lists out the completed maps with their times sorted by the time with oldest first.
+list-recently-completed-times - Lists out the last 6 maps completed.
+list-few-old-completed-times - Lists out the 6 maps with the oldest completion time.
+list-uncompleted-random/list-handful - Lists out the 6 maps to play that you havent completed or are very old, within a low tier if difficulty
+
+usage: gojump.sh [operation] <MAP_NAME> <TIME> <SOLDIER/DEMOMAN(s/d)>
+Format the time as follows: HH:MM:SS.MS
+submit-time - Submit a run, will create a file or will read the file and verify it then backup the run and submit if better
+```
+
+# License 
+GPL3+ 
+