summaryrefslogtreecommitdiff
path: root/README.md
blob: b2c77052c3472ac039d3af0ffb4e7a8253900134 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
<h1 align="center"> WeatherFetch πŸ“ΊοΈ </h1>
<div align = "center">
<a href="https://t.me/ArcaneDevStudio" target="_blank" rel="noopener noreferrer">
    <img src="https://img.shields.io/badge/Telegram-@ArcaneDevStudio-blue?style=flat-square&logo=telegram" alt="Telegram">
</a>
<a href="https://github.com/Nam4ik/WeatherFetch/actions", target="_blank", rel="noopener noreferrer">
    <img src="https://github.com/Nam4ik/WeatherFetch/actions/workflows/rust.yml/badge.svg?event=push", alt="rust.yml">
</a> 
<img src="https://img.shields.io/badge/Version-v0.1-blue.svg">

<br>
<br>
  
**WeaterFetch: Written on rust fetch tool like Neofetch or FastFetch but with Weather.**
This is my pet project, but I think someone might like it. I am the sole developer, so if you encounter any issues or bugs, please inform me or create a pull request. Stil in development, no work version.

</div>

<h2 align="center"> Tech details πŸ—οΈ</h2>

> [!WARNING] 
> Not all of this fns can be implemented with openmeteo API 

- Uses the free open-meteo API, which requires coordinates or configuration to function properly.
- Displays images in the terminal. (WIP)
- Provides various time intervals, including daily, hourly, and minute-by-minute updates, as well as current information.
- Can send alerts. (WIP)
- In case of internet connectivity issues, it can download information from a cache.

WIP - work in progress. Its much more harder with free open-meteo API.

<h2 align="center"> Using ⛽️</h2>

>[!WARNING]
>Coordinates and an internet connection are required if cache not builded properly.
>To cache weather data you cah run `wfetch rebuild-cache`

`wfetch -h`

<h2 align = "center"> Installation πŸ”</h2>

**Build from source:**
```shell 
git clone https://github.com/Nam4ik/WeatherFetch
cd WeatherFetch
cargo build -rv 
sudo mv ./target/release/wfetch /usr/local/bin
cargo clean
wfetch config && cp src/arts.yaml ~/.config/WeatherFetch/
```
And dont forget switch coords in config to your!
<br>

**Or just download release and move it to one of** `$PATH` **dirs.**

<br>

> [!TIP]
> **Soon in aur.**