Merge pull request #7 from cocoanautz/branch-AboutUs-Isaac

Update AboutUs.md and README.md

README.md

@@ -1,16 +1,27 @@
-[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/se-edu/addressbook-level3/actions)
+[![CI Status](https://github.com/AY2324S2-CS2103T-T13-2/tp/workflows/Java%20CI/badge.svg)](https://github.com/AY2324S2-CS2103T-T13-2/tp/actions)
 
 [![codecov](https://codecov.io/gh/AY2324S2-CS2103T-T13-2/tp/graph/badge.svg?token=X8FVKZE2OZ)](https://codecov.io/gh/AY2324S2-CS2103T-T13-2/tp)
 
 ![Ui](docs/images/Ui.png)
 
-* This is **a sample project for Software Engineering (SE) students**.<br>
-  Example usages:
-  * as a starting point of a course project (as opposed to writing everything from scratch)
-  * as a case study
-* The project simulates an ongoing software project for a desktop application (called _AddressBook_) used for managing contact details.
-  * It is **written in OOP fashion**. It provides a **reasonably well-written** code base **bigger** (around 6 KLoC) than what students usually write in beginner-level SE modules, without being overwhelmingly big.
-  * It comes with a **reasonable level of user and developer documentation**.
-* It is named `AddressBook Level 3` (`AB3` for short) because it was initially created as a part of a series of `AddressBook` projects (`Level 1`, `Level 2`, `Level 3` ...).
-* For the detailed documentation of this project, see the **[Address Book Product Website](https://se-education.org/addressbook-level3)**.
-* This project is a **part of the se-education.org** initiative. If you would like to contribute code to this project, see [se-education.org](https://se-education.org#https://se-education.org/#contributing) for more info.
+# InternBook
+
+As a student looking for internships, it is often hard to keep track of the many different internship applications.
+One of the solutions is to do so in an excel sheet, 
+but such a user interface can become very hard to manage when there are many concurrent applications going on.
+Thus, having a CLI based interface can make it much easier for data input and query.
+Our app hopes to reduce the effort needed to track internships, so that students can spend the time searching instead. 
+Our app will aim to record employers’ emails, job descriptions and application dates.
+
+## Getting Started
+1. Ensure that Java 11 is available on your machine.
+2. Download the jar file from here.
+3. Navigate to the file's location in the shell of your choice.
+4. Run the jar file with the follow command
+```shell
+java -jar internBook.jar
+```
+
+For the detailed documentation of this project, see the **[InternBook Product Website](https://ay2324s2-cs2103t-t13-2.github.io/tp/)**.
+
+This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).

docs/AboutUs.md

@@ -11,15 +11,14 @@ You can reach us at the email `seer[at]comp.nus.edu.sg`
 
 ## Project team
 
-### John Doe
+### Isaac Ong
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/cocoanautz.png" width="200px">
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/cocoanautz)]
 
-* Role: Project Advisor
+* Role: Developer
+* Responsibilities: Dev Ops
 
 ### Jane Doe
 

docs/index.md

@@ -3,17 +3,17 @@
   title: ""
 ---
 
-# AddressBook Level-3
+# InternBook 
 
 [![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/se-edu/addressbook-level3/actions)
 [![codecov](https://codecov.io/gh/se-edu/addressbook-level3/branch/master/graph/badge.svg)](https://codecov.io/gh/se-edu/addressbook-level3)
 
 ![Ui](images/Ui.png)
 
-**AddressBook is a desktop application for managing your contact details.** While it has a GUI, most of the user interactions happen using a CLI (Command Line Interface).
+**InternBook is a desktop application for managing your internship contact details.** While it has a GUI, most of the user interactions happen using a CLI (Command Line Interface).
 
-* If you are interested in using AddressBook, head over to the [_Quick Start_ section of the **User Guide**](UserGuide.html#quick-start).
-* If you are interested about developing AddressBook, the [**Developer Guide**](DeveloperGuide.html) is a good place to start.
+* If you are interested in using InternBook, head over to the [_Quick Start_ section of the **User Guide**](UserGuide.html#quick-start).
+* If you are interested about developing InternBook, the [**Developer Guide**](DeveloperGuide.html) is a good place to start.
 
 
 **Acknowledgements**