diff --git a/README.md b/README.md index e23ffed..9031e8d 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,57 @@ -# smartpark-app +# Stevens SmartPark -Campus parking information system \ No newline at end of file +Stevens SmartPark is a proposed campus parking information system for Stevens Institute of Technology. + +The goal of the project is to make it easier for students to view parking information for major campus parking locations before deciding where to park. + +# Intended Users + +The initial system is intended for Stevens students who need parking information for campus parking areas. + +# Proposed Parking Locations + +The project currently focuses on these five proposed locations: + +- Babbio Garage +- River Lot +- 8th Street Lot +- Castle Point Hall Lot +- Howe Center Lot + +# Planned Parking Information + +For each parking location, the planned application may display information such as: + +- available parking spaces +- total parking spaces +- whether the location is open or closed +- opening and closing times +- overnight parking rules +- handicapped parking availability +- electric-vehicle charging availability and, when applicable, pricing + +# Simulated Parking Activity + +Real-time Stevens parking data may not be available to the project, so the application is planned to support simulated parking activity. + +For example, when a simulated vehicle enters a parking location, the available-space count can decrease by one. When a simulated vehicle leaves, the available-space count can increase by one. + +Any parking capacity or availability values used during development are **sample data** and should not be interpreted as live Stevens parking information. + +Example: +```text +Parking Location: Babbio Garage +Total Spaces: 120 # sample data +Available Spaces: 42 # sample data +Open: Yes +Opening Time: 7:00 AM +Closing Time: 11:00 PM +Overnight Parking: No +EV Charging: Available +``` + +# Current Project Status + +The SmartPark application itself and live Stevens campus parking data are not currently deployed. + +The team's currently deployed operational work hub is Gitea, which is being used for source control, issues, pull requests, reviews, and project history. \ No newline at end of file