From 3f3e27b98b53e1172ea462af3ee703a45b5fd56b Mon Sep 17 00:00:00 2001 From: Anthony Jean Date: Wed, 4 Oct 2017 22:44:56 -0400 Subject: [PATCH] Add the custom configurations to readme --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index 83dcc1c..574dd5f 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,7 @@ A Ruby script that colorizes the `ls` output with color and icons. Here are the - [Usage](#usage) - [Installation](#installation) - [Recommended configurations](#recommended-configurations) +- [Custom configuration] (#custom-configurations) - [Updating](#updating) - [Uninstallation](#uninstallation) - [Contributing](#contributing) @@ -92,6 +93,22 @@ A Ruby script that colorizes the `ls` output with color and icons. Here are the subl $(dirname $(gem which colorls))/yaml ``` +# Custom configurations + +[(Back to top)](#table-of-contents) + +You can overwrite the existing icons and colors mapping by creating yaml files in ~/.config/lscolors. + +Each .yaml file inside the lib/colorls/yaml directory of this repo can be overwrited. + +Let's say you want to add an icon for swift files, you might create a `files.yaml` inside `~/.config/lscolors` and add the following: + +``` +swift: "\uF179" +``` + +Which will add the Apple logo to swift files. + # Updating [(Back to top)](#table-of-contents)