Skip to content

Commit

Permalink
Added readme file doc for CountryAPI
Browse files Browse the repository at this point in the history
  • Loading branch information
thesohailjafri committed Oct 11, 2023
1 parent ea8bc19 commit a82c3c5
Show file tree
Hide file tree
Showing 3 changed files with 40 additions and 0 deletions.
40 changes: 40 additions & 0 deletions Existing_API_Collection/CountryAPI/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
## Table of Contents

- [About](#about)
- [How to use](#how-to-use)
- [Build with](#build-with)
- [Author](#author)
- [Contributors](#contributors)

## About

[Country API](https://github.com/developer-student-clubs/APIVerse/tree/master/Existing_API_Collection/CountryAPI) is a REST API that provides information about countries including name, flag, capital, continent, population, currency, languages, etc.

## How to use

- Clone the repository from [APIVerse](https://github.com/developer-student-clubs/APIVerse)
- Open the folder Existing_API_Collection > CountryAPI
- Copy the path of index.html file
- Paste the path in your browser
- You will see the following page
- <img src="screenshots/home.png" alt="Home Page" width="500px">
- Type the name of the country in the search box and click on search
- You will see the following page
- <img src="screenshots/search.png" alt="Search Page" width="500px">
- Click on the name of the country to see the details

## Build with

- HTML
- CSS
- JavaScript
- [Rest-Countries API](https://restcountries.com/v3.1/)

## Author

- Mahek-Garala [GitHub](https://github.com/Mahek-Garala)
- Mahek Garala [LinkedIn](https://www.linkedin.com/in/mahek-garala-179911261/)

## Contributors

![Contributors](https://contrib.rocks/image?repo=developer-student-clubs/APIVerse)
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit a82c3c5

Please sign in to comment.