https://github.com/openpeeps/watchout

⚡️ A fast, small, lightweight filesystem monitor. Yellin' for changes!
https://github.com/openpeeps/watchout

app cross-platform file-change-notifications file-monitor file-monitoring filesystem language-agnostic monitoring-tool nim-lang watchout

Last synced: about 1 month ago
JSON representation

⚡️ A fast, small, lightweight filesystem monitor. Yellin' for changes!

• Host: GitHub
• URL: https://github.com/openpeeps/watchout
• Owner: openpeeps
• License: mit
• Created: 2022-02-11T06:24:32.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-05-18T06:38:47.000Z (7 months ago)
• Last Synced: 2024-05-18T07:31:59.519Z (7 months ago)
• Topics: app, cross-platform, file-change-notifications, file-monitor, file-monitoring, filesystem, language-agnostic, monitoring-tool, nim-lang, watchout
• Language: Nim
• Homepage:
• Size: 426 KB
• Stars: 14
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


    


    ⚡️ A fast, small, lightweight filesystem monitor. Yellin' for changes!





  API reference | Download (not yet)


    



## 😍 Key Features

todo

- [x] Open Source | `MIT` license

## Installing

```

nimble install watchout

```

## Examples

```nim

import watchout

proc onFound(file: File) =

  echo "Found"

  echo file.getPath

proc onChange(file: File) =

  echo "Changed"

  echo file.getPath

proc onDelete(file: File) =

  echo "Deleted"

  echo file.getPath

var w = newWatchout("../tests/*.nim", onChange, onFound, onDelete)

w.start(waitThreads = true)

```

### ❤ Contributions & Support

- 🐛 Found a bug? [Create a new Issue](https://github.com/openpeeps/watchout/issues)

- 👋 Wanna help? [Fork it!](https://github.com/openpeeps/watchout/fork)

- 😎 [Get €20 in cloud credits from Hetzner](https://hetzner.cloud/?ref=Hm0mYGM9NxZ4)

- 🥰 [Donate to OpenPeeps via PayPal address](https://www.paypal.com/donate/?hosted_button_id=RJK3ZTDWPL55C)

### 🎩 License

Watchout [MIT license](https://github.com/openpeeps/watchout/blob/main/LICENSE).


Copyright © 2023 OpenPeeps & Contributors — All rights reserved.