Updated markdown and travis files

This commit is contained in:
Athitya 2017-07-07 20:25:38 +05:30
parent 39b7282c8a
commit 6479092635
3 changed files with 26 additions and 13 deletions

View file

@ -11,13 +11,13 @@ script:
- bundle exec rubocop
- bundle exec rspec
- rake install
- lc
- lc -d
- lc -f
- lc -sd
- lc -sf
- lc -1
- lc -r
- colorls
- colorls -d
- colorls -f
- colorls -sd
- colorls -sf
- colorls -1
- colorls -r
install:
- gem install bundler

View file

@ -25,10 +25,10 @@ Please proceed with a Pull Request only after you're assigned. It'd be sad if yo
- adding better icons to [YAML files](lib/yaml/)
- adding more flag options to the ruby gem.
3. (Optional) To test whether `lc` is working properly, do
3. (Optional) To test whether `colorls` executable is working properly, do
```sh
rake install
lc # start using lc
colorls # start using colorls
```
4. (Required for YAML file changes) These are the specifications for the YAML files -

View file

@ -13,7 +13,8 @@ A Ruby script that colorizes the `ls` output with color and icons. Here are the
- [Usage](#usage)
- [Installatation](#installation)
- [Optional configurations](#optional-configurations)
- [Recommended configurations](#recommended-configurations)
- [Updating](#updating)
- [Uninstallation](#uninstallation)
- [Contributing](#contributing)
- [License](#license)
@ -64,15 +65,15 @@ A Ruby script that colorizes the `ls` output with color and icons. Here are the
rehash
```
4. Start using `lc` :tada:
4. Start using `colorls` :tada:
# Optional configurations
[(Back to top)](#table-of-contents)
1. To add some flag options by default, add this to your shell configuration file (`~/.bashrc`, `~/.zshrc` or `~/.fishrc`) :
1. To add some short command (say, `lc`) with some flag options (say, `-r`)b y default, add this to your shell configuration file (`~/.bashrc`, `~/.zshrc` or `~/.fishrc`) :
```sh
alias lc='lc -r'
alias lc='colorls -r'
```
2. For changing the icon(s) to other unicode icons of choice (select icons from [here](https://nerdfonts.com/)), change the YAML files in a text editor of your choice (say, `subl`)
@ -82,6 +83,18 @@ A Ruby script that colorizes the `ls` output with color and icons. Here are the
_NOTE: If you're using iTerm2 on Mac, you may have to enable the nerd-font at iTerm2 > Preferences > Profiles > Text > Non-Ascii font > Knack Regular Nerd Font Complete_
# Updating
[(Back to top)](#table-of-contents)
Want to update to the latest version of `colorls`?
```sh
gem update colorls
```
# Uninstallation
[(Back to top)](#table-of-contents)