Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
d2phap committed Nov 29, 2022
1 parent edca6d0 commit 34e874f
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 11 deletions.
17 changes: 7 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,31 @@
# FileWatcherEx for Windows
A wrapper of `System.IO.FileSystemWatcher` to standardize the events and avoid false change notifications, used in [ImageGlass](https://github.com/d2phap/ImageGlass) project.
A wrapper of `System.IO.FileSystemWatcher` to standardize the events and avoid false change notifications. It has been being used in [ImageGlass - A lightweight, versatile image viewer](https://github.com/d2phap/ImageGlass) project.

This project is based on the *VSCode FileWatcher*: https://github.com/Microsoft/vscode-filewatcher-windows

![Nuget](https://img.shields.io/nuget/dt/FileWatcherEx?color=%2300a8d6&logo=nuget)


## Resource links
- Nuget package: [https://www.nuget.org/packages/FileWatcherEx](https://www.nuget.org/packages/FileWatcherEx/)
- Project url: [https://github.com/d2phap/FileWatcherEx](https://github.com/d2phap/FileWatcherEx)
- Website: [https://imageglass.org](https://imageglass.org)
- Nuget package: [https://www.nuget.org/packages/FileWatcherEx](https://www.nuget.org/packages/FileWatcherEx/)

## Features
- Standardize the events of `System.IO.FileSystemWatcher`.
- Standardizes the events of `System.IO.FileSystemWatcher`.
- No false change notifications when a file system item is created, deleted, changed or renamed.
- Support .NET 6.0.
- Supports .NET 6.0, 7.0.

## Installation
Run the command
Run the command:

```bash
# Nuget package
Install-Package FileWatcherEx


# or use Github registry
dotnet add PROJECT package FileWatcherEx
```

## Usage
See Demo project for full details
See Demo project for full details!

```cs
using FileWatcherEx;
Expand Down
5 changes: 4 additions & 1 deletion Source/FileWatcherEx/FileWatcherEx.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,10 @@
<VersionPrefix>2.2.0</VersionPrefix>
<PackageLicenseExpression>MIT</PackageLicenseExpression>
<PackageReleaseNotes>See https://github.com/d2phap/FileWatcherEx/releases</PackageReleaseNotes>
<Authors>$(Authors)</Authors>
<Authors>d2phap</Authors>
<Title>FileWatcherEx - A file system watcher</Title>
<IncludeSymbols>True</IncludeSymbols>
<SymbolPackageFormat>snupkg</SymbolPackageFormat>
</PropertyGroup>

<ItemGroup>
Expand Down

0 comments on commit 34e874f

Please sign in to comment.