From cde1590a2a3e9340c35015526e6119323e96a8dc Mon Sep 17 00:00:00 2001 From: Xevion Date: Tue, 24 Dec 2019 04:52:34 -0600 Subject: [PATCH] add readme with purpose and demonstration, prep for images --- README.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e515beb..2a109f0 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,17 @@ # true-filetype - Commandline utility that automatically finds and renames files to their correct file extension + +## Purpose + +I've been noticing in my hoarding of media that a large number of images seem to be the incorrect file type. Image readers have no trouble reading the correct image as they check the data before the filetype, but IrfanView enjoys pestering me, telling me they have incorrect image types. So, I decided to sit down at 4AM in the morning to create a utility using one of the thousand Pypi applications. + +It's a little buggy and seems to be detecting incorrectly, as I'll show below. + +However, I'm not really intending this to be a big project, just a proof of concept idea that I can work on later should I want to continue it. + +If you'd like to improve my code, feel free to send in a PR or Issue with appropriate details. Thanks. + +## Demonstration + +Currently the only command is [`truefile detect`](https://github.com/Xevion/truefile/blob/9faadcbf4c231c67a9fef85f19e4ff57eba0f937/truefile/cli.py#L24). I hope to add in a couple more commands and arguments that will better suite the end user (me). + +![](./image1.png) \ No newline at end of file