Skip to content

Commit

Permalink
Updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ashmit0920 committed Jul 17, 2024
1 parent 34d1caf commit 5be0747
Showing 1 changed file with 22 additions and 1 deletion.
23 changes: 22 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,17 @@ Fidy is a command-line tool for organizing files in a directory based on their e

## Installation

#### 1. Download the installer executable for Windows. (Recommended)

The installer file can be downloaded from [Fidy Installer](./deployment/fidy_Installer.exe). Download the exe file and run it to install Fidy.

Open your terminal and run Fidy!
```
fidy
```

#### 2. Install using 'go install' command.

Make sure you have [Go](https://go.dev/doc/install) installed in your system.

You can install Fidy using the following command in your terminal:
Expand All @@ -25,7 +36,7 @@ Run fidy
```
fidy
```
**Update:** Fidy will be released soon as a binary for Windows, Linux and MacOS!
**Update:** Fidy will be released soon as a binary for Linux and MacOS!

## Usage

Expand All @@ -40,6 +51,11 @@ Fidy can remember your name and send personalized greetings! Set your name using
fidy -name YOUR_NAME
```

Check the installed version
```
fidy -version
```

Organize a directory
```
fidy -dir PATH_TO_YOUR_DIR
Expand All @@ -60,6 +76,11 @@ Perform a Dry Run, without doing any actual changes to your directory.
fidy -dir PATH_TO_YOUR_DIR -dryrun -include txt,png -exclude pdf
```

Clean all the empty folders and sub-folders within your target directory.
```
fidy -dir PATH_TO_YOUR_DIR -cleanAll -verbose
```

## Upcoming features

- Log file
Expand Down

0 comments on commit 5be0747

Please sign in to comment.