Skip to content

Commit

Permalink
Created README.md
Browse files Browse the repository at this point in the history
For existing Apis, resolves issue dishamodi0910#144
  • Loading branch information
its-kritika committed May 31, 2024
1 parent d0cf41f commit cd49dff
Show file tree
Hide file tree
Showing 2 changed files with 58 additions and 0 deletions.
28 changes: 28 additions & 0 deletions Existing_API_Collection/CountryAPI/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Country API
Welcome to the Country API! This API is built to provide you with comprehensive information about all 195 countries of the world. Simply name the country, and I'll send you on a tour with detailed information about it!!

## Features
- **Fetch Detailed Information about a Country:** Retrieve comprehensive data about any of the 195 countries, including their capital, population, languages and currency.
- **Error Handling:** Robust error handling to ensure meaningful error messages and smooth API usage.
- **Simple and Easy-to-Use Interface:** Designed with utmost simplicity, it has an easy-to-use interface.
- **Search Functionality:** Easily search for countries by name to retrieve information quickly.

## Technologies Used
- HTML
- Vanilla CSS
- JavaScript
- API ( for fetching data )

# API Integration
This application uses `https://restcountries.com/v3.1/name/any-country-name?fullText=true` to fetch the data.

## Installation
To set up the Country API locally, follow these steps:

- Clone the repository
- Switch to Existing_API_Collection folder `cd Existing_API_Collection`
- Now switch to CountryAPI folder `cd CountryAPI`
- Run command `.\/country.html`

## Screenshots
![Screenshot (396)](https://github.com/its-kritika/APIVerse/assets/144522556/41633810-7310-4b32-9843-eb6a18e4aaff)
30 changes: 30 additions & 0 deletions Existing_API_Collection/DictionaryAPI/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Dictionary API
Welcome to the Dictionary API! This API offers an innovative approach to accessing an online dictionary. Say goodbye to traditional methods of searching for words using letters in alphabetical order. With this API, you can retrieve word definitions, usage, pronunciation, and more without the hassle of manual searching. Empower your applications with efficient and convenient access to comprehensive lexical data.

## Features
- **Word Definitions:** Retrieve detailed definitions for words in English.
- **Word Examples:** Get usage examples of words in context to better understand their meaning.
- **Pronunciations:** Retrieve pronunciations of words in different dialects and accents.
- **Part of Speech:** Identify the part of speech of a word (noun, verb, adjective, etc.).
- **Error Handling:** Robust error handling to ensure meaningful error messages and smooth API usage.
- **Simple Interface:** Designed with utmost simplicity, it has an easy-to-use interface.

## Technologies Used
- HTML
- Vanilla CSS
- JavaScript
- API ( for fetching data )

# API Integration
This application uses `https://api.dictionaryapi.dev/api/v2/entries/en/search-any-word` to fetch the data.

## Installation
To set up the Dictionary API locally, follow these steps:

- Clone the repository
- Switch to Existing_API_Collection folder `cd Existing_API_Collection`
- Now switch to CountryAPI folder `cd DictionaryAPI`
- Run command `.\/dic.html`

## Screenshots
![Screenshot (395)](https://github.com/its-kritika/APIVerse/assets/144522556/7efc5d32-464a-4a11-aa26-33883e5a006c)

0 comments on commit cd49dff

Please sign in to comment.