Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add FAQ and features #27

Merged
merged 1 commit into from
Aug 7, 2024
Merged

Add FAQ and features #27

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions README.md
View file
Open in desktop
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.