Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
deveshsangwan committed Mar 11, 2024
1 parent 473d02c commit 9d4d187
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Cricket Score API
# 🏏 Cricket Score API

Welcome to the Cricket Score API! This project is designed to provide real-time cricket scores using TypeScript and npm.

## Table of Contents
## 📚 Table of Contents

- [Cricket Score API](#cricket-score-api)
- [Status](#status)
Expand All @@ -12,21 +12,21 @@ Welcome to the Cricket Score API! This project is designed to provide real-time
- [Running Tests](#running-tests)
- [License](#license)

## Status
## 🚀 Status

<!-- [![Firebase Deployment](https://github.com/deveshsangwan/cricketScoreApi/actions/workflows/firebase-hosting-merge.yml/badge.svg?branch=main)](https://github.com/deveshsangwan/cricketScoreApi/actions/workflows/firebase-hosting-merge.yml) -->

[![Run Tests](https://github.com/deveshsangwan/cricketScoreApi/actions/workflows/test.yml/badge.svg)](https://github.com/deveshsangwan/cricketScoreApi/actions/workflows/test.yml)

## Code Coverage
## 📊 Code Coverage

Our aim is to maintain high code coverage to ensure the quality of the project. Here are our current stats:

[![codecov](https://codecov.io/gh/deveshsangwan/cricketScoreApi/graph/badge.svg?token=A3JMLLNTG4)](https://codecov.io/gh/deveshsangwan/cricketScoreApi)
![Functions](https://img.shields.io/badge/functions-98.03%25-brightgreen.svg?style=flat)
![Lines](https://img.shields.io/badge/lines-91%25-brightgreen.svg?style=flat)

## Getting Started
## 🚀 Getting Started

To get a copy of the project up and running on your local machine, follow these steps:

Expand All @@ -42,13 +42,13 @@ You can also run the project with Docker:

Remember to replace `<your-mongodb-url>` with your actual MongoDB URL.

## Usage
## 📝 Usage

- Make a GET request to `/liveMatches` to get the URLs of all the current live matches.
- Make a GET request to `/matchStats` to get the statistics for all matches.
- Make a GET request to `/matchStats/:matchId` to get the statistics for a single match. Replace `:matchId` with the ID of the match you want statistics for.

## Running Tests
## 🧪 Running Tests

After setting up the project, you can run the tests to ensure everything is working as expected. Follow these steps:

Expand All @@ -60,6 +60,6 @@ This command will run the test suite for the project.

This command will run the tests and generate a coverage report.

## License
## 📜 License

This project is licensed under the Creative Commons Attribution-NonCommercial 4.0 International (CC BY-NC 4.0) License. See the [LICENSE.md](LICENSE.md) file for details.

0 comments on commit 9d4d187

Please sign in to comment.