after SLC rubric and README.md

README.md

@@ -1,10 +1,13 @@
+
+# Job Link
+
 This is my app `Job Link` for the 2023-2024 FBLA Coding and Programming event.
+WI SLC Winner.
 
-It uses the [Flutter Framework](https://flutter.dev/) for the front end and [Dart Language](https://dart.dev/) for both the front end and API.
+It uses the [Flutter Framework](https://flutter.dev/) for the front end and the [Dart Language](https://dart.dev/) for both the front end and API.
 
-Please view the README in [fbla_ui](fbla_ui/README.md) and [fbla-api](fbla-api/README.md) for specific instructions for installation and usage for each part of the app.
+## 3rd Party Libraries
 
-3rd Party Libraries Used:
 - [dart_jsonwebtoken](https://pub.dev/packages/dart_jsonwebtoken)
 - [sliver_tools](https://pub.dev/packages/sliver_tools)
 - [flutter_sticky_header](https://pub.dev/packages/flutter_sticky_header)
@@ -14,9 +17,25 @@ Please view the README in [fbla_ui](fbla_ui/README.md) and [fbla-api](fbla-api/R
 - [postgres](https://pub.dev/packages/postgres)
 - [argon2](https://pub.dev/packages/argon2)
 
+## Requirements
+
+### Job Link
+- **OS**: Windows, Linux, MacOS, Android, IOS. Note that some releases may not contain a MacOS or IOS build.
+- Stable internet connection.
+
+### API
+- **OS**: Windows, Linux, MacOS
+- Stable internet connection.
+
+## Installation/Usage
+
+Please view the README in [fbla_ui](fbla_ui/README.md) and [fbla-api](fbla-api/README.md) for specific instructions for installation and usage for each part of the app.
+
+## Competitions
+
 [Here](https://docs.google.com/presentation/d/1ZbSE9RqobU2T-NDIm3CUtT_9nEhOm3_B47NZl1-c_QA) is the presentation used for competitions
 
-## WI State Leadership Conference
+### WI State Leadership Conference
 
 1st Place
 
@@ -26,16 +45,14 @@ Used release 0.1.1
 
 Questions asked (with my answers):
 
-Q: Why did you decide to use the apps (framework and tools I assume) you used?\
-A: I decided to use Flutter primarily because of it's cross-platform capabilities and it's integration with the [Material design specification](https://m3.material.io/). I also decided to use it because I had a some previous experience with Flutter and Dart, and Dart is somewhat similar to Java which I also had experience with.
+**Q**: Why did you decide to use the apps (framework and tools I assume) you used?\
+**A**: I decided to use Flutter primarily because of its cross-platform capabilities and its integration with the [Material design specification](https://m3.material.io/). I also decided to use it because I had some previous experience with Flutter and Dart, and Dart is somewhat similar to Java which I also had experience with.
 
-This one seems to just be a clarification for the `User input is validated` catagory of the [scoring sheet](https://connect.fbla.org/headquarters/files/High%20School%20Competitive%20Events%20Resources/Individual%20Guidelines/Presentation%20Events/Coding--Programming.pdf) (page 5-6)\
-Q: You mentioned that you validated that the description [of the business] is required, do you validate all the inputs or just that?\
-A: I validate that all of the required fields are inputted, and I also check for a valid email address and website format. 
+This one seems to just be a clarification for the `User input is validated` category of the [scoring sheet](https://connect.fbla.org/headquarters/files/High%20School%20Competitive%20Events%20Resources/Individual%20Guidelines/Presentation%20Events/Coding--Programming.pdf) (page 5-6)\
+**Q**: You mentioned that you validated that the description [of the business] is required, do you validate all the inputs or just that?\
+**A**: I validate that all of the required fields are inputted, and I also check for a valid email address and website format.
 
 This seems to be for the [scoring sheet](https://connect.fbla.org/headquarters/files/High%20School%20Competitive%20Events%20Resources/Individual%20Guidelines/Presentation%20Events/Coding--Programming.pdf) (page 5-6) `Code Quality` section.\
 While looking through a binder of the presentation and source code:\
-Q: Is your source code all properly commented?\
-A: While it is hard to comment UI code because of the nature of it, I did my best to use comments where applicable, and I also provide extensive documentation of the installation and usage of the app in the documentation in the README files.
-
-
+**Q**: Is your source code all properly commented?\
+**A**: While it is hard to comment UI code because of the nature of it, I did my best to use comments where applicable, and I also provide extensive documentation of the installation and usage of the app in the documentation in the README files.