https://github.com/r-unic/inotify-fixed

Fixed version for Crystal 1.8.1 of the inotify.cr shard.
https://github.com/r-unic/inotify-fixed

Last synced: about 2 months ago
JSON representation

Fixed version for Crystal 1.8.1 of the inotify.cr shard.

• Host: GitHub
• URL: https://github.com/r-unic/inotify-fixed
• Owner: R-unic
• License: mit
• Created: 2023-05-09T05:32:12.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2023-05-09T05:37:36.000Z (over 1 year ago)
• Last Synced: 2024-12-02T07:56:38.874Z (about 2 months ago)
• Language: Crystal
• Homepage:
• Size: 8.79 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# inotify

Inotify bindings for [Crystal language](https://github.com/crystal-lang/crystal).

[![GitHub release](https://img.shields.io/github/release/petoem/inotify.cr.svg?style=flat-square)](https://github.com/petoem/inotify.cr/releases)

[![Travis](https://img.shields.io/travis/petoem/inotify.cr.svg?style=flat-square)](https://travis-ci.org/petoem/inotify.cr)

[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](https://github.com/petoem/inotify.cr/blob/master/LICENSE)

## Installation

Add this to your application's `shard.yml`:

```yaml

dependencies:

  inotify:

    github: petoem/inotify.cr

    version: 1.0.1

```

## Usage

```crystal

require "inotify"

# To watch a file or directory ...

watcher = Inotify.watch "/path/to/file.txt" do |event|

  # your awesome logic

end

# ... for 10 seconds.

sleep 10.seconds

watcher.close

```

*Note: You have to run something in the main fiber or else your program will exit.* 

More documentation can be found [here](https://petoem.github.io/inotify.cr/).

## Development

To enable logging to `STDOUT` set `INOTIFY_LOG_LEVEL` environment variable to `DEBUG`.

## Contributing

1. [Fork it!](https://github.com/petoem/inotify.cr/fork)

2. Create your feature branch (git checkout -b my-new-feature)

3. Commit your changes (git commit -am 'Add some feature')

4. Push to the branch (git push origin my-new-feature)

5. Create a new Pull Request

## Contributors

- [petoem](https://github.com/petoem) Michael Petö - creator, maintainer