Skip to content

Commit

Permalink
Add FAQ and features
Browse files Browse the repository at this point in the history
  • Loading branch information
yury-fedotov committed Aug 7, 2024
1 parent 151174e commit ee7e09e
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,12 @@ In directories of any size and structure.
</div>
</div>

- ⚡️ Analyzes large software projects in < 1 sec
- 🤝 Respects `.gitignore` files
- 🏠 Works locally and doesn't send your data anywhere
- 📖 Performs only read operations and doesn't modify files
- 💾 Has been tested on directories up to 100 GB of size, 20,000 files, 5,000 subfolders

## Use cases

Unfolder can be useful for:
Expand Down Expand Up @@ -84,3 +90,15 @@ Would:
* While identifying duplicates, ignore files smaller than `image` alias implies (10 Mb).

You can also run `unfolder -h` to get info on arguments.

## FAQ

### What makes Unfolder fast?

* Unfolder **is written in pure Rust**, which gives a very performant baseline.
* It **leverages parallelism** to analyse files faster (as much faster as many cores you have).
* To check for duplicate files, it **leverages a very fast hashing algorithm**: `xxHash64`.

### Can Unfolder delete files?

No. As can be validated from its open-source code, it performs only does read operations.

0 comments on commit ee7e09e

Please sign in to comment.