Metadata-Version: 2.4
Name: file-modification-checker
Version: 0.2.0
Summary: A fast CLI tool to check for modifications.
Author: Arel Umut Koyluoglu
Description-Content-Type: text/markdown

# Modification Checking Tool
A fast CLI tool to detect new, deleted, and modified files in a folder.

## 0.1.0

### Installing and Importing
> **Installing**
Use:
```bash
pip install file_modfication_checker==0.1.0
```
>**Importing**
Use:
```python
import file_modfication_checker
```
### Command Usage
> **How To Use**
Usage:
```bash
mcheck <folder> [OPTIONS]
```
Arguments:
<folder>           Name of folder to check

Options:
-e, --exclude     File types to ignore

> **Result**
- Red Text: files that were deleted
- Green Text: files that were added
- Yellow Text: files that were modified

## 0.2.0

### Installing and Importing
> **Installing**
Use:
```bash
pip install file_modfication_checker==0.2.0
```
>**Importing**
Use:
```python
import file_modfication_checker
```
### Comand Usage
> **How To Use**
Usage:
```bash
mcheck <folder> [OPTIONS]
```
Arguments:
<folder>           Name of folder to check

Options:
-e, --exclude      File types to ignore

-i, --information  Type of information to show

> **Result**
- Red Text: files that were deleted - no infromation will be given
- Green Text: files that were added - requested information will be given
- Yellow Text: files that were modified - requested information will be given
