From b1057aeb0381a29d86e518732f227799dbf7cf6e Mon Sep 17 00:00:00 2001 From: Sampo Silvennoinen <20028934+stscoundrel@users.noreply.github.com> Date: Sat, 8 Jan 2022 13:05:12 +0200 Subject: [PATCH] Readme: add gitignore comparison --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e9a83f3..c1c7ad6 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,12 @@ In some project setups, one can use incorrect file extension without actually br Alliser goes through files, and lets you know if you have non-allowed file types within the project. +#### Wait, can't I do this with gitignore? + +Depending on your use case, you might! There are differences though. + +Gitignore is commonly used for completely blocking something from your repo. Things in there are artifacts you _dont want_ in repo, maybe dist, builds or external deps. Things that Alliser checks are things you _do want_ in your repo, like source code / tests you've written, but they may be of incorrect or discouraged format. + ### Usage @@ -74,6 +80,6 @@ console.log(incorrectFiles); Alliser is smart enough not to list files from folders like `node_modules` or `.git`. If you feel like some common ignore is missing from defaults, PRs & issues are welcome. -#### What's in the name? +### What's in the name? "Alliser" is picked from GRR Martins "A Song Of Ice And Fire". Alliser Thorne is a character who would definitely tell you if you're of "the wrong type".