world-countries-capitals - npm Package Compare versions

Comparing version 1.0.0 to 1.1.0

package.json

 {
 	"name": "world-countries-capitals",
-	"version": "1.0.0",
+	"version": "1.1.0",
 	"description": "A simple NPM package to get capitals, currency, native language etc. of all the countries in the world",
 	"main": "index.js",
 	"scripts": {
-		"test": "echo \"Error: no test specified\" && exit 1"
+		"test": "echo \"Error: no test specified\" && exit 1",
+		"semantic-release": "semantic-release"
 	},
 	"repository": {
 		"type": "git",
-		"url": "git+https://github.com/bhatvikrant/world-countries-capitals.git"
+		"url": "https://github.com/bhatvikrant/world-countries-capitals.git"
 	},
@@ -13,0 +14,0 @@ "keywords": [

README.md

 # world-countries-capitals
+
+#### A simple [NPM](https://www.npmjs.com/package/world-countries-capitals) package to get capitals, currency, native language etc. of all the countries in the world
+
+![world-countries-capitals](assets/world-countries-capitals.gif)
+
+## Getting started
+
+[![NPM](https://nodei.co/npm/world-countries-capitals.png?compact=true)](https://nodei.co/npm/world-countries-capitals/)
+
+## Installation
+
+[![NPM INSTALL](http://img.shields.io/badge/npm-install-blue.svg?style=for-the-badge&logo=npm)](https://docs.npmjs.com/getting-started/installing-npm-packages-locally) [![NODE JS](http://img.shields.io/badge/Node-JS-teal.svg?style=for-the-badge&logo=node.js)](https://nodejs.org/en/) [![NODE JS](https://img.shields.io/npm/v/world-countries-capitals?logo=npm&label=world-countries-capitals&style=for-the-badge)](https://www.npmjs.com/package/world-countries-capitals)
+
+This is a [Node.js](https://nodejs.org/en/) module available through the
+[npm registry](https://www.npmjs.com/).
+
+Before using, [download and install Node.js](https://nodejs.org/en/download/).
+
+Installation is done using the
+**[`npm install`](https://docs.npmjs.com/getting-started/installing-npm-packages-locally)** command:
+
+```bash
+$ npm i world-countries-capitals --save
+```
+
+## Usage
+
+---
+
+- **getAllCountryDetails()** This method returns an **array of objects** of all countries, each containing **country**, **capital**, **currency** and **native_language**.
+
+```json
+    [
+        {
+            "country": "Afghanistan",
+            "capital": "Kabul",
+            "currency": "Afghani",
+            "native_language": "Dari Persian, Pashto"
+        },
+        {
+            "country": "Albania",
+            "capital": "Tirane",
+            "currency": "Lek",
+            "native_language": "Albanian"
+        },
+
+        ...
+    ]
+```
+
+---
+
+- **getAllCountries()** This method returns an **array** of **names** of all countries.
+
+```javascript
+    [
+        'Afghanistan',
+        'Albania',
+        'Algeria',
+        'Andorra',
+        'Angola',
+        'Antigua & Barbuda',
+        'Argentina',
+        'Armenia',
+        'Australia',
+        'Austria',
+        'Azerbaijan',
+        ...
+    ]
+```
+
+---
+
+- **getCountiesByLanguage(languageSpoken)** This method returns an **array of objects**, each containing **country**, **capital**, **currency** and **native_language** sorted by the _languageSpoken_.
+
+Response for languageSpoken = 'Hindi'
+
+```javascript
+[
+	{
+		country: 'Fiji',
+		capital: 'Suva',
+		currency: 'Fijian Dollar',
+		native_language: 'english, bau fijian, hindi',
+	},
+	{
+		country: 'India',
+		capital: 'New Delhi',
+		currency: 'Indian Rupee',
+		native_language: 'hindi, english',
+	},
+];
+```
+
+---
+
+- **getCountryDetailsByName(countryName)** This method returns an **array of objects**, each containing **country**, **capital**, **currency** and **native_language** sorted by the _name of the country_ .
+
+Response for countryName = 'india'
+
+```javascript
+[
+	{
+		country: 'india',
+		capital: 'New Delhi',
+		currency: 'Indian Rupee',
+		native_language: 'Hindi, English',
+	},
+];
+```
+
+---
+
+- **getCountryDetailsByCapital(capital)** This method returns an **array of objects**, each containing **country**, **capital**, **currency** and **native_language** sorted by the _capital_ .
+
+Response for capital = 'delhi'
+
+```javascript
+[
+	{
+		country: 'India',
+		capital: 'new delhi',
+		currency: 'Indian Rupee',
+		native_language: 'Hindi, English',
+	},
+];
+```
+
+---
+
+- **getRandomCountry()** This method returns a random country everytime.
+
+```bash
+» node app.js
+Tuvalu
+
+» node app.js
+Bhutan
+
+» node app.js
+Saudi Arabia
+```
+
+##### where app.js is the fie containing the function call.
+
+---
+
+- **getNRandomCountriesData(n)** This method returns an array having **n** random country objects, each object containing **country**, **capital**, **currency** and **native_language**.
+
+Response for n = 3
+
+```javascript
+[
+	{
+		country: 'Burundi',
+		capital: 'Bujumbura',
+		currency: 'Burundi Franc',
+		native_language: 'Kirundi, French',
+	},
+	{
+		country: 'Palau',
+		capital: 'Melekeok',
+		currency: 'United States Dollar',
+		native_language: 'English, Palauan',
+	},
+	{
+		country: 'Dominican Republic',
+		capital: 'Santo Domingo',
+		currency: 'Dominican Peso',
+		native_language: 'Spanish',
+	},
+];
+```
+
+---
+
+---
+
+# Want to contribute?
+
+[![Open Source Love](https://badges.frapsoft.com/os/v3/open-source-175x29.png?v=103)](https://github.com/NikhilNamal17)
+
+> Please check issues **[here](https://github.com/bhatvikrant/world-countries-capitals/issues)**!
+
+---
+
+## License
+
+![GitHub license](https://img.shields.io/github/license/bhatvikrant/world-countries-capitals.svg?style=for-the-badge&logo=github)
+
+---
+
+---
+
+## Let's get connected
+
+[![Twitter Follow](https://img.shields.io/twitter/follow/vikrantbhat1022.svg?style=for-the-badge&logo=twitter)](https://twitter.com/vikrantbhat1022)
+
+[![GitHub followers](https://img.shields.io/github/followers/bhatvikrant.svg?label=Follow&style=for-the-badge&logo=github)](https://github.com/bhatvikrant/)
+
+[![LinkedIn](https://img.shields.io/static/v1.svg?label=connect&message=@vikrantbhat&color=success&logo=linkedin&style=for-the-badge&logoColor=white&colorA=blue)](https://www.linkedin.com/in/vikrant-bhat-2b6221189/)
+
+<hr>
+
+[![forthebadge](https://forthebadge.com/images/badges/built-with-love.svg)](https://github.com/bhatvikrant/world-countries-capitals) [![forthebadge](https://forthebadge.com/images/badges/made-with-javascript.svg)](https://github.com/bhatvikrant/world-countries-capitals) [![forthebadge](https://forthebadge.com/images/badges/makes-people-smile.svg)](https://github.com/bhatvikrant/world-countries-capitals) [![forthebadge](https://forthebadge.com/images/badges/check-it-out.svg)](https://github.com/bhatvikrant/world-countries-capitals)

New alerts

Mixed license

License

(Experimental) Package contains multiple licenses.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

83286

increased by154.65%

Number of package files

6

increased by50%

Number of lines in readme file

207

increased by10250%

Worsened metrics

Number of low license alerts

1

increased byInfinity%

No dependency changes