Skip to content

Commit

Permalink
fix documentation and add maintainers
Browse files Browse the repository at this point in the history
  • Loading branch information
sn99 authored Nov 10, 2022
1 parent 3aa5485 commit 2107b6b
Showing 1 changed file with 15 additions and 5 deletions.
20 changes: 15 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,13 @@

[![Rust](https://github.com/SubconsciousCompute/fsfilter-rs/actions/workflows/rust.yml/badge.svg)](https://github.com/SubconsciousCompute/fsfilter-rs/actions/workflows/rust.yml)
[![Crates.io](https://img.shields.io/crates/v/fsfilter-rs?style=flat-square)](https://crates.io/crates/fsfilter-rs)
[![docs.rs](https://img.shields.io/docsrs/fsfilter-rs?style=flat-square)](https://docs.rs/fsfilter-rs/latest/fsfilter_rs/)

A rust library to monitor filesystem and more in windows.

![shared_def](readme_resources/shared_def.png)

### MINIFILTER
## MINIFILTER

See [MINIFILTER.md](MINIFILTER.md) for building the minifilter or just [right click install using the `.inf` file
provided in releases](https://github.com/SubconsciousCompute/fsfilter-rs/releases/latest/download/snFilter.zip).
Expand All @@ -18,12 +19,11 @@ You can also build using [EWDK](EWDKbuild.md) if you don't want to install Visua

**NOTE: Enable Loading of Test Signed Drivers by executing `Bcdedit.exe -set TESTSIGNING ON` in administrative cmd.**

### RUNNING EXAMPLE
## RUNNING EXAMPLE

Use `cargo run --bin minifilter --release` to run the example application or just [run the `.exe` provided in
releases](https://github.com/SubconsciousCompute/fsfilter-rs/releases/latest/download/minifilter.exe) as administrator (
for some reason the new default terminal on 2H22 is very, very slow
).
releases](https://github.com/SubconsciousCompute/fsfilter-rs/releases/latest/download/minifilter.exe) as administrator (for
some reason the new default terminal (not the one that opens when you run it as administrator) on 2H22 is very, very slow).

The program starts to print the `IOMessage` which is defined like:

Expand Down Expand Up @@ -57,6 +57,16 @@ running scripts to make multiple temporary files). Although depending on you con
`cargo run --bin minifilter --release` you might see spikes reaching `1-3%` but that is because of the console itself (
comment out the `writeln!` in the bin example) or try changing consoles (maybe run `minifilter.exe` directly).

## MAINTAINERS

Feel free to open issues to ask any questions/queries. You are free to ping the current maintainers.

Currently maintained by the following:
- [sn99](https://github.com/sn99) (original author)

Previous maintainers:
- N/A

## LICENSE

This project is licensed under the terms of the [MIT license](LICENSE.md).
Expand Down

0 comments on commit 2107b6b

Please sign in to comment.