Skip to content

Commit a82a86f

Browse files
authored
Enhance README with project badges and details
Added badges for release, build status, commit activity, and license. Expanded project description to include CLI tool and Python library details.
1 parent 6aa4109 commit a82a86f

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,15 @@
11
# Tariff Fetch
22

3-
The project provides a CLI tool that retrieves electric and gas utility tariff data from multiple providers.
3+
[![Release](https://img.shields.io/github/v/release/switchbox-data/tariff_fetch)](https://img.shields.io/github/v/release/switchbox-data/tariff_fetch)
4+
[![Build status](https://img.shields.io/github/actions/workflow/status/switchbox-data/tariff-fetch/main.yml?branch=main)](https://github.com/switchbox-data/tariff_fetch/actions/workflows/main.yml?query=branch%3Amain)
5+
[![Commit activity](https://img.shields.io/github/commit-activity/m/switchbox-data/tariff_fetch)](https://img.shields.io/github/commit-activity/m/switchbox-data/tariff_fetch)
6+
[![License](https://img.shields.io/github/license/switchbox-data/tariff_fetch)](https://img.shields.io/github/license/switchbox-data/tariff_fetch)
7+
8+
A CLI tool, and python library, to simplify downloading electric and gas utility tariff data from multiple providers in a consistent data format.
9+
10+
- **Github repository**: <https://github.com/switchbox-data/tariff_fetch/>
11+
- **Documentation**: <https://switchbox-data.github.io/tariff_fetch/>
12+
- **PyPI page**: <https://pypi.org/project/tariff_fetch/>
413

514
## Requirements
615
- Python 3.11+

0 commit comments

Comments
 (0)