diff --git a/readme.md b/readme.md index ba3486925..2be690910 100644 --- a/readme.md +++ b/readme.md @@ -1,9 +1,26 @@ -# Spring KidClinic Sample Application +# GlowTouch KidClinic (built on Spring) -## Running kidclinic locally +## Running Kidclinic locally ``` + git clone https://github.com/sasankglowtouch/kidclinic.git cd kidclinic ./mvnw spring-boot:run ``` -You can then access kidclinic here: http://localhost:8080/ \ No newline at end of file +You can then access kidclinic here: http://localhost:8080/ + +## The Purpose of KidClinic +The purpose of KidClinic is to simulate the building of an enterprise application using Java and Spring. Being built off of Spring's PetClinic, KidClinic is used to understand the process of building an app in order to gain knowledge and make future development more efficient and successful. + +## Current Features +- [x] Adding new parents and children +- [x] View current list of doctors and their specialities +- [x] Search through database of parents + +## Upcoming Additions +| Addition | Stage of Development | Expected Development Time | +| -------- | -------------------- | ------------------------- | +| Login System | Research | Short Term | +| Google Map API Integration | Research | Long Term | +| Updated child's information | Research | Immediate | +| Calendar Scheduliing | Research | Long Term |