Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Suvadip-sana authored Jun 14, 2024
1 parent 7f5312d commit 106459a
Showing 1 changed file with 63 additions and 2 deletions.
65 changes: 63 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,63 @@
# Currency-Converter
A currency converter web app that use the Exchange Rate API for real time exchange rate and FlagsAPI for coresponding flag.
# Real Time Currency Converter

A real-time currency converter built with HTML, CSS, and JavaScript. This application fetches exchange rates from [exchangerate-api.com](https://www.exchangerate-api.com) and country flags from [flagsapi.com](https://flagsapi.com). By default, it shows the conversion from 1 USD to INR. If the user inputs 0 or leaves the input box empty, it automatically sets the value to 1 and displays the result. The application supports a list of 160 countries. It is also comes with responsiveness.

## Features

- Real-time currency conversion using exchange rates fetched from exchangerate-api.com.
- Displays country flags using flagsapi.com.
- Default conversion from 1 USD to INR.
- Handles zero or empty input by setting the value to 1.
- Supports conversion between 160 different currencies.
- Swap button to switch between 'from' and 'to' currencies with a smooth transition.
- Responsive.

## Files

- `index.html`: The main HTML file containing the structure of the currency converter.
- `style.css`: The CSS file for styling the currency converter.
- `script.js`: The JavaScript file containing the main logic for fetching data and updating the UI.
- `codes.js`: A JavaScript file containing the country codes and corresponding currency codes.

## Installation

1. Clone the repository:
```bash
git clone https://github.com/yourusername/repo-name.git

2. Navigate to the Project Directory
```bash
cd repo-name
## Usage
1. Open `index.html` in your web browser.
2. Enter the value you want to convert in the input box.
3. Select the 'from' and 'to' countries from the dropdown lists.
4. Click the convert button to see the exchange rate.
5. Use the swap button to switch the 'from' and 'to' countries.
## Example
1. Enter the value: `1`
2. Select 'from' country: `United States (USD)`
3. Select 'to' country: `India (INR)`
4. Click the convert button to see the exchange rate.
## Live Demo
![Currency Converter Demo](https://github.com/Suvadip-sana/Currency-Converter/assets/78638404/008346ad-08fb-4ad7-81f1-69632f4d48b6)
Check out for live demo [Here](https://suvadip-sana.github.io/Currency-Converter/).
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## Acknowledgements
- Exchange rates provided by [exchangerate-api.com](https://www.exchangerate-api.com)
- Country flags provided by [flagsapi.com](https://flagsapi.com)

0 comments on commit 106459a

Please sign in to comment.