Skip to content

Commit

Permalink
docs: Add README.md version English
Browse files Browse the repository at this point in the history
  • Loading branch information
k3ii committed Sep 20, 2024
1 parent f6755e7 commit a8bcfdc
Showing 1 changed file with 36 additions and 0 deletions.
36 changes: 36 additions & 0 deletions EN-README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Kouran
`kouran` is a simple CLI tool that provides information on power outages in Mauritius.
The data is sourced from a [dataset](https://github.com/MrSunshyne/mauritius-power-outages) created by [Sandeep Ramgolam](https://github.com/MrSunshyne).

![demo](./assets/demo.jpeg)

## Features

* Display power outages for today.
* View upcoming outages for tomorrow.
* Use the all subcommand to get information on outages for both today and tomorrow.

## Installation

You can install `kouran` using one of the following methods:

### Using Cargo

If you have Rust's package manager, Cargo, installed, you can install `kouran` with:

```bash
cargo install kouran
```

### Using Homebrew

For macOS users, you can install `kouran` using Homebrew:

```bash
brew install k3ii/tap/kouran
```
Check the release page to install the pre-built binaries.

## Motivation

The primary motivation behind kouran is to gain hands-on experience with building CLI tools in Rust language and interacting with APIs. While the tool is still simple, it offers a functional and helpful utility for anyone looking to stay updated on power outages across Mauritius from their terminal.

0 comments on commit a8bcfdc

Please sign in to comment.