tiny_update_notifier 2.0.0

Tiny update notifier utility for rust cli programs
Documentation 
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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104


<h1 align="center">🔔 Tiny Update Notifier 🔔</h1>

<p align="center">
  <a href="https://github.com/Araxeus/tiny-update-notifier" target="_blank">
    <img alt="GitHub" src="https://img.shields.io/badge/GitHub-100000?style=for-the-badge&logo=github&logoColor=white" />
  </a>
  <a href="https://crates.io/crates/tiny_update_notifier" target="_blank">
    <img alt="Version" src="https://img.shields.io/crates/v/tiny_update_notifier?logo=semanticweb&style=for-the-badge&labelColor=yellow&color=grey" onerror='this.onerror=undefined; this.src="https://img.shields.io/badge/version-1.0.0-blue.svg?cacheSeconds=2592000"'/>
  </a>
</p>
<p align="center">
  <a href="https://github.com/Araxeus/tiny-update-notifier/blob/main/LICENSE" target="_blank">
    <img alt="License: MIT" src="https://img.shields.io/github/license/Araxeus/tiny-update-notifier?color=blue&style=plastic" />
  </a>
  <a href="https://github.com/Araxeus/tiny-update-notifier" target="_blank">
    <img alt="Maintenance" src="https://img.shields.io/badge/Maintained%3F-yes-green.svg?style=plastic" />
  </a>
</p>

<p align="center">
Tiny update notifier utility for rust cli programs
</p>

---

Checks for update on program launch if **more than 24h have passed** since the last check, then pops up a notification if a new version was found 📢
> supports crates.io and github releases

![App Screenshot](https://user-images.githubusercontent.com/78568641/210151741-701ca397-d9bb-4acc-8e62-292a1d7495d4.png)

## Installation


Install tiny_update_notifier using Cargo

```bash
  cargo add tiny_update_notifier
```
    
## Usage

##### Multi-threaded / Concurrent / Non-blocking / Asynchronous :

```rust
// check on crates.io
tiny_update_notifier::check_cratesIO(pkg_version, pkg_name);

// check on github releases
tiny_update_notifier::check_github(pkg_version, pkg_name, pkg_repo_url);
```

##### Single-threaded / Nonparallel / blocking / Synchronous :

```rust
tiny_update_notifier::Notifier::new().run(
    tiny_update_notifier::Source,
    pkg_version,
    pkg_name,
    pkg_repo_url
);
```

## Examples


```rust
// Spawns a thread to check for updates on Crates.io and notify user if there is a new version available.
use tiny_update_notifier::check_cratesIO;

fn main() {
    check_cratesIO(
        env!("CARGO_PKG_VERSION"),
        env!("CARGO_PKG_NAME"),
    );
}
```
```rust
// Spawns a thread to check for updates on GitHub Releases and notify user if there is a new version available.
use tiny_update_notifier::check_github;

fn main() {
    check_github(
        env!("CARGO_PKG_VERSION"),
        env!("CARGO_PKG_NAME"),
        env!("CARGO_PKG_REPOSITORY"),
    );
}
```

```rust
// equivalent to the code above
use std::thread;
use tiny_update_notifier::{Notifier, Source};

fn main() {
    thread::spawn(|| {
        Notifier::new(
            Source::Github,
            env!("CARGO_PKG_VERSION"),
            env!("CARGO_PKG_NAME"),
            env!("CARGO_PKG_REPOSITORY"),
        )
        .run();
    });
}
```
----
> Used by https://github.com/Araxeus/ls-interactive/