diff --git a/README.md b/README.md index df5200c..a86aeeb 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,25 @@ -# git-hooks +# hooks -Ce dépôt contient les hooks que j'utilise. \ No newline at end of file +Ce dépôt contient les hooks que j'utilise. + +## sanitizeFileName.bash + +Ce script permet de supprimer les caractères spéciaux du nom des fichiers. Par exemple *J'fais un test, héhé.md* devient *j-fais-un-test-hehe.md*. + +Le script s'utilise aussi bien en ligne de commande qu'en tant que hook. + +### CLI + +```bash +pulsar@zazu:~$ bash ~/git/www.ykn.fr/.tools/sanitizeFileName.bash ~/git/www.ykn.fr/content/articles/ +``` + +### Hook + +```bash +tee ~/git/www.ykn.fr/.git/hooks/pre-commit <