Skip to content

Commit 95422d2

Browse files
authored
docs: improve README formatting and header spacing
Created a professional README.md for the Discount Calculator script, including how it works, example output, license, author info, and file listing.
1 parent 94cd5d0 commit 95422d2

File tree

1 file changed

+32
-2
lines changed

1 file changed

+32
-2
lines changed

README.md

Lines changed: 32 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,32 @@
1-
# python-week-3-assignment
2-
Assignment documentation and releases.
1+
# 💸 Discount Calculator
2+
3+
This Python script calculates the final price of an item after applying a discount — but only if the discount is **20% or more**.
4+
5+
## 🚀 How It Works
6+
7+
1. User enters the original price and discount percentage
8+
2. If the discount is **>= 20%**, it's applied
9+
3. Otherwise, the original price is returned
10+
4. Invalid input is handled gracefully
11+
12+
## 💡 Example Output
13+
14+
Enter the original price: 100
15+
Enter the discount percentage: 25
16+
Discount applied! Final price: $75.00
17+
18+
Enter the discount percentage: 15
19+
No discount applied. Final price: $100.00
20+
21+
## 📂 Files
22+
23+
- `discount_calculator.py`: Core script
24+
25+
## 👨‍💻 Author
26+
27+
Augusto Mate
28+
📧 mate.augusto.mz@gmail.com
29+
30+
## 🪪 License
31+
32+
This project is licensed under the [MIT License](LICENSE).

0 commit comments

Comments
 (0)