Add the custom configurations to readme

This commit is contained in:
Anthony Jean 2017-10-04 22:44:56 -04:00
parent b898af16d5
commit 3f3e27b98b

View file

@ -18,6 +18,7 @@ A Ruby script that colorizes the `ls` output with color and icons. Here are the
- [Usage](#usage) - [Usage](#usage)
- [Installation](#installation) - [Installation](#installation)
- [Recommended configurations](#recommended-configurations) - [Recommended configurations](#recommended-configurations)
- [Custom configuration] (#custom-configurations)
- [Updating](#updating) - [Updating](#updating)
- [Uninstallation](#uninstallation) - [Uninstallation](#uninstallation)
- [Contributing](#contributing) - [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 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 # Updating
[(Back to top)](#table-of-contents) [(Back to top)](#table-of-contents)