Skip to content

Commit e27d4aa

Browse files
authored
Revise README for JavaScript Utility Suite
Updated project description, features, and usage instructions in README.md.
1 parent 7d0513b commit e27d4aa

1 file changed

Lines changed: 31 additions & 16 deletions

File tree

README.md

Lines changed: 31 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,39 @@
1-
# Utility Hub
1+
# JavaScript Utility Suite
22

3-
A simple web-based application built for **CIS 111 – Introduction to Web Programming**.
4-
Includes two utilities:
3+
A lightweight, browser-based toolset featuring a mathematical calculator and a NATO phonetic alphabet converter. Built with vanilla JavaScript to demonstrate core DOM manipulation, event handling, and algorithm implementation without external dependencies.
54

6-
1. **Basic Calculator** – Performs addition, subtraction, multiplication, and division with history tracking.
7-
2. **NATO Phonetic Converter** – Converts words or sentences into their NATO phonetic equivalent.
5+
![Calculator Demo](YOUR_IMAGE_LINK_HERE)
86

9-
## Features
7+
## 🚀 Live Demo
8+
[View Live Demo](https://05ashton.github.io/JavaScript-Utility-Suite/)
109

11-
- Input validation for calculator numbers
12-
- Dynamic history of calculations
13-
- Supports uppercase and lowercase letters for NATO conversion
14-
- Clear buttons for both utilities
10+
## 🛠 Features
1511

16-
## Usage
12+
### 1. Mathematical Calculator
13+
* **Arithmetic Operations:** Supports addition, subtraction, multiplication, and division.
14+
* **Input Validation:** Prevents invalid inputs to ensure calculation stability.
15+
* **History Tracking:** Dynamically renders a history log of recent calculations using DOM manipulation.
1716

18-
Open `p4.html` in a browser to use the app.
17+
### 2. NATO Phonetic Converter
18+
* **Real-time Conversion:** Instantly translates input text into the NATO phonetic alphabet (e.g., "Hello" → "Hotel Echo Lima Lima Oscar").
19+
* **Case Insensitivity:** robustly handles mixed uppercase and lowercase input.
20+
* **String Parsing:** specific algorithm to map characters to phonetic values.
1921

20-
## Technologies
22+
![Converter Demo](YOUR_IMAGE_LINK_HERE)
2123

22-
- HTML
23-
- CSS
24-
- JavaScript
24+
## 💻 Technical Highlights
25+
26+
This project was built to master the fundamentals of **Vanilla JavaScript**:
27+
28+
* **DOM Manipulation:** interacting with the Document Object Model to update the UI without page reloads.
29+
* **Event Listeners:** handling user clicks and keystrokes efficiently.
30+
* **Logic Implementation:** writing custom algorithms for string parsing and mathematical logic.
31+
* **CSS Styling:** custom styling for a responsive and clean user interface.
32+
33+
## 📂 Project Structure
34+
35+
```text
36+
JavaScript-Utility-Suite/
37+
├── index.html # Main entry point and UI structure
38+
├── styles.css # Custom styling for the interface
39+
└── script.js # Core logic for calculator and converter

0 commit comments

Comments
 (0)