summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md36
1 files changed, 36 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a618d3e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,36 @@
+<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/TG-SOURCES-RP2P/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>
+
+- Uses the https://openweathermap.org/api/one-call-3, without coordinate args or in config can't work.
+- Supports the images in terminal
+- Supports many timings like Daily, Hourly, Minutely, Current
+- Support alerts
+- If internet broken load the info from cache
+
+<h2 align="center"> Using ⛽️</h2>
+
+>[!WARNING]
+>Coordinates and an internet connection are required. This information is not stored or used in any way.
+
+`wfetch -h`
+
+<h2 align = "center"> Installation </h2>
+
+<br>