Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ashiishme authored Oct 2, 2020
1 parent 26749dd commit 0ad8f34
Showing 1 changed file with 36 additions and 0 deletions.
36 changes: 36 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,39 @@ Current version is available at [Chrome web store](https://chrome.google.com/web
## Screenshot

![covid-stats-screenshot](https://repository-images.githubusercontent.com/274438498/99045180-c6ec-11ea-943a-ac294b0fbc1f)

## Installation

```
git clone https://github.com/ashiishme/covid-stats.git
yarn install
```

After all the packages are installed,

```
yarn start
```

This extension can be tested as a normal web application directly on browser. If you want to test it as a chrome extension ( which you should ). You must enable the developer mode on your chrome browser so that it can allow you to upload unpacked extension for testing.

Check the guide below to learn more:
[Getting started with Chrome Extension](https://developer.chrome.com/extensions/getstarted)

Now, once you are familiar with loading unpacked extenstion. You can build this project and upload the build for testing.

```
yarn build
```

## Contribute

- Fork this repository
- Create your own branch to make changes or fix the issues
- Push changes to your fork & create a PR.

Give this project a :star:, it motivates me :smile:.

Check more about [contributing](https://github.com/ashiishme/covid-stats/blob/development/.github/CONTRIBUTING.md) guidelines. You must follow the guidelines in order to get your PR merged. If you are sending PR for `Hacktoberfest2020`, the PR must compile with the guidelines or it will be marked as `invalid`.

[Code of Conduct](https://github.com/ashiishme/covid-stats/blob/development/.github/CODE_OF_CONDUCT.md)

0 comments on commit 0ad8f34

Please sign in to comment.