Skip to content

Commit

Permalink
📝 update readme
Browse files Browse the repository at this point in the history
- make new-york / "new york" example more accurate
- move badges to top
- format
  • Loading branch information
ttytm committed Mar 12, 2023
1 parent c207097 commit 3687a41
Showing 1 changed file with 14 additions and 8 deletions.
22 changes: 14 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,15 @@
# 🦀 wthrr-the-weathercrab

<div>
<a href="https://crates.io/crates/wthrr" target="_blank">
<img alt="crates.io" src="https://img.shields.io/crates/v/wthrr?style=flat-square" />
</a>
<a href="https://github.com/tobealive/wthrr-the-weathercrab/actions/workflows/ci.yml?query=branch%3Amain" target="_blank">
<img alt="crates.io" src="https://img.shields.io/github/actions/workflow/status/tobealive/wthrr-the-weathercrab/ci.yml?branch=main&style=flat-square" />
</a>
</div>
<br>

`wthrr` lives in your terminal and her passion is meteorology.

If you spend time in the TUI, you'll have a little companion nearby who knows about the weather.
Expand Down Expand Up @@ -32,7 +42,7 @@ wthrr melbourne

Depending on the place you are looking for, you might need to be more specific.
For example, the above call will get Melbourne in Australia. If you are aiming for Melbourne in the US, ask for `melbourne,florida`.
If the address contains spaces, separate them with a hyphen or enclose them in quotation marks (e.g., "new-york" or "new york").
If the address contains spaces, separate them with a hyphen or enclose them in quotation marks (e.g., `new-york` or `"new york"`).

To search explicitly for a weather station in the vicinity, call

Expand Down Expand Up @@ -155,12 +165,6 @@ Win: `C:\Users\<user>\AppData\Roaming\weathercrab\`

## Installation

<a href="https://crates.io/crates/wthrr" target="_blank">
<img alt="crates.io" src="https://img.shields.io/crates/v/wthrr?style=flat-square" />
</a>
<br>
<br>

Use rusts package manger to install wthrr in its latest version from source.

```
Expand All @@ -186,5 +190,7 @@ A simple changelog can be found on the [releases page](https://github.com/tobeal
##

<div align="right">
<a href='https://ko-fi.com/O4O4IOTYR' target='_blank'><img height='36' style='border:0px;height:36px;' src='https://storage.ko-fi.com/cdn/kofi5.png?v=3' border='0' alt='Buy Me a Coffee at ko-fi.com' /></a>
<a href='https://ko-fi.com/O4O4IOTYR' target='_blank'>
<img height='36' style='border:0px;height:36px;' src='https://storage.ko-fi.com/cdn/kofi5.png?v=3' border='0' alt='Buy Me a Coffee at ko-fi.com' />
</a>
</div>

0 comments on commit 3687a41

Please # to comment.