Skip to content

Commit

Permalink
Updates readme
Browse files Browse the repository at this point in the history
  • Loading branch information
zekinah committed Aug 31, 2020
1 parent 4d97d08 commit a71f3ed
Show file tree
Hide file tree
Showing 2 changed files with 48 additions and 22 deletions.
30 changes: 21 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,11 @@ Stable tag: 1.0.4
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html

This plugin provides shortcode that displays the live recorded data of the covid19 in the whole world.
This plugin provides shortcode and widgets that can displays the latest data of the covid19 in the whole world.

## Description

This plugin provides data of how many patient(s) are active, confirmed, dead or recovered, in a world, and the continent or country assigned.
This plugin provides latest data of how many patient(s) are active, confirmed, dead or recovered, in a world, and the continent or country assigned.

## Features

Expand All @@ -30,20 +30,32 @@ This plugin provides data of how many patient(s) are active, confirmed, dead or
* Shortcode for every continent and shows the data of covid 19 from that continent.
* Shortcode that provides table for that shows the list of all countries and its data of covid19.
* Shortcode for the overall total global data that is recorded.
* Dashboard Widget on the admin area that shows the Global Status of the covid19.
* Widgets available for Elementor, an alternative for shortcode.

## Shortcode
## Shortcodes

* `[zone-covid19]` - Showing the global data.
* `[zone-covid19 country="US"]` - Showing the data of specific country.
* `[zone-covid19 continent="North America"]` - Showing the data of specific continent.
* `[zone-covid19 country="US,Philippines"]` - Showing the data of multiple countries.
* `[zone-covid19 continent="North America, Asia"]` - Showing the data of multiple continents.
* `[zone-covid19]` - Showing the global data card.
* `[zone-covid19 country="US"]` - Showing the card data of specific country.
* `[zone-covid19 continent="North America"]` - Showing the data card of specific continent.
* `[zone-covid19 country="US,Philippines"]` - Showing the data cards of multiple countries.
* `[zone-covid19 continent="North America, Asia"]` - Showing the data cards of multiple continents.
* `[zone-covid19-table]` - Showing the list of all countries and its data in a table form.
* `[zone-covid19-history-graph]` - Showing the historical graph of covid19 cases.
* `[zone-covid19-history-graph]` - Showing the historical graph of covid19 cases from the start.
* `[zone-covid19-map]` - Showing the world heat map for covid19 cases.

Additional: Add `dark="true"` if you want a dark mode.

## Widgets Available in Elementor
An alternative for shortcode to output the data.

* Global Status Card
* Countries Status Card
* Continents Status Card
* Table Status
* History Graph
* Heat Map

## Installation

1. Upload `zone-pandemic-covid-19` to the `/wp-content/plugins/` directory
Expand Down
40 changes: 27 additions & 13 deletions README.txt
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,11 @@ Stable tag: 1.0.1
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html

This plugin provides shortcode that displays the live recorded data of the covid19 in the whole world.
This plugin provides shortcode and widgets that can displays the latest data of the covid19 in the whole world.

== Description ==

This plugin provides data of how many patient(s) are active, confirmed, dead or recovered, in a world, and the continent or country assigned.

== API used ==

* [Disease SH](https://github.com/disease-sh/API) - [Privacy](https://github.com/NovelCOVID/API/blob/master/privacy.md)
* [Johns Hopkins University](https://github.com/CSSEGISandData/COVID-19)
* [Worldometers](https://www.worldometers.info/coronavirus/)
This plugin provides latest data of how many patient(s) are active, confirmed, dead or recovered, in a world, and the continent or country assigned.

== Features ==

Expand All @@ -29,20 +23,37 @@ This plugin provides data of how many patient(s) are active, confirmed, dead or
* Shortcode that provides table for that shows the list of all countries and its data of covid19.
* Shortcode for the overall total global data that is recorded.
* Dashboard Widget on the admin area that shows the Global Status of the covid19.
* Widgets available for Elementor, an alternative for shortcode.

== Shortcodes ==

* `[zone-covid19]` - Showing the global data.
* `[zone-covid19]` - Showing the global data cards.
* `[zone-covid19 country="US"]` - Showing the data of specific country.
* `[zone-covid19 continent="North America"]` - Showing the data of specific continent.
* `[zone-covid19 country="US,Philippines"]` - Showing the data of multiple countries.
* `[zone-covid19 continent="North America, Asia"]` - Showing the data of multiple continents.
* `[zone-covid19 continent="North America"]` - Showing the data card of specific continent.
* `[zone-covid19 country="US,Philippines"]` - Showing the data cards of multiple countries.
* `[zone-covid19 continent="North America, Asia"]` - Showing the data cards of multiple continents.
* `[zone-covid19-table]` - Showing the list of all countries and its data in a table form.
* `[zone-covid19-history-graph]` - Showing the historical graph of covid19 cases.
* `[zone-covid19-history-graph]` - Showing the historical graph of covid19 cases from the start.
* `[zone-covid19-map]` - Showing the world heat map for covid19 cases.

Additional: Add `dark="true"` if you want a dark mode.

== Widgets Available in Elementor ==
An alternative for shortcode to output the data.

* Global Status Card
* Countries Status Card
* Continents Status Card
* Table Status
* History Graph
* Heat Map

== API used ==

* [Disease SH](https://github.com/disease-sh/API) - [Privacy](https://github.com/NovelCOVID/API/blob/master/privacy.md)
* [Johns Hopkins University](https://github.com/CSSEGISandData/COVID-19)
* [Worldometers](https://www.worldometers.info/coronavirus/)

Support
Feel free to help with development or issue reporting to

Expand Down Expand Up @@ -85,6 +96,9 @@ The API that we are using on this plugin was blocked in Russian Government Regul
8. Result of the Shortcode for the World Heat Map.

== Changelog ==
= 1.0.5 =
* Elementor Integration

= 1.0.4 =
* Fixed minor bugs for showing Single Country
* Fixed minor bugs for showing Single continent
Expand Down

0 comments on commit a71f3ed

Please sign in to comment.