Skip to content

Commit c8ac32a

Browse files
tcyrusGraham42
authored andcommitted
Update README.md (#66)
- Changed PNG Badges to SVG - Added Styling to Code Blocks - Added <kbd> tags for Key Bindings
1 parent 0ea31ae commit c8ac32a

File tree

1 file changed

+30
-22
lines changed

1 file changed

+30
-22
lines changed

README.md

Lines changed: 30 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Tmux Plugin Manager
22

3-
[![Build Status](https://travis-ci.org/tmux-plugins/tpm.png?branch=master)](https://travis-ci.org/tmux-plugins/tpm)
3+
[![Build Status](https://travis-ci.org/tmux-plugins/tpm.svg?branch=master)](https://travis-ci.org/tmux-plugins/tpm)
44

5-
Installs and loads TMUX plugins.
5+
Installs and loads `tmux` plugins.
66

77
Tested and working on Linux, OSX, and Cygwin.
88

@@ -12,54 +12,60 @@ Requirements: `tmux` version 1.9 (or higher), `git`, `bash`.
1212

1313
Clone TPM:
1414

15-
$ git clone https://github.com/tmux-plugins/tpm ~/.tmux/plugins/tpm
15+
```bash
16+
$ git clone https://github.com/tmux-plugins/tpm ~/.tmux/plugins/tpm
17+
```
1618

1719
Put this at the bottom of `.tmux.conf`:
1820

19-
# List of plugins
20-
set -g @plugin 'tmux-plugins/tpm'
21-
set -g @plugin 'tmux-plugins/tmux-sensible'
21+
```bash
22+
# List of plugins
23+
set -g @plugin 'tmux-plugins/tpm'
24+
set -g @plugin 'tmux-plugins/tmux-sensible'
2225

23-
# Other examples:
24-
# set -g @plugin 'github_username/plugin_name'
25-
# set -g @plugin '[email protected]/user/plugin'
26-
# set -g @plugin '[email protected]/user/plugin'
26+
# Other examples:
27+
# set -g @plugin 'github_username/plugin_name'
28+
# set -g @plugin '[email protected]/user/plugin'
29+
# set -g @plugin '[email protected]/user/plugin'
2730

28-
# Initialize TMUX plugin manager (keep this line at the very bottom of tmux.conf)
29-
run '~/.tmux/plugins/tpm/tpm'
31+
# Initialize TMUX plugin manager (keep this line at the very bottom of tmux.conf)
32+
run '~/.tmux/plugins/tpm/tpm'
33+
```
3034

3135
Reload TMUX environment so TPM is sourced:
3236

33-
# type this in terminal if tmux is already running
34-
$ tmux source ~/.tmux.conf
37+
```bash
38+
# type this in terminal if tmux is already running
39+
$ tmux source ~/.tmux.conf
40+
```
3541

3642
That's it!
3743

3844
### Installing plugins
3945

4046
1. Add new plugin to `~/.tmux.conf` with `set -g @plugin '...'`
41-
2. Press `prefix + I` (capital I, as in **I**nstall) to fetch the plugin.
47+
2. Press `prefix` + <kbd>I</kbd> (capital I, as in **I**nstall) to fetch the plugin.
4248

4349
You're good to go! The plugin was cloned to `~/.tmux/plugins/` dir and sourced.
4450

4551
### Uninstalling plugins
4652

4753
1. Remove (or comment out) plugin from the list.
48-
2. Press `prefix + alt + u` (lowercase u as in **u**ninstall) to remove the plugin.
54+
2. Press `prefix` + <kbd>alt</kbd> + <kbd>u</kbd> (lowercase u as in **u**ninstall) to remove the plugin.
4955

5056
All the plugins are installed to `~/.tmux/plugins/` so alternatively you can
5157
find plugin directory there and remove it.
5258

5359
### Key bindings
5460

55-
`prefix + I`
61+
`prefix` + <kbd>I</kbd>
5662
- Installs new plugins from GitHub or any other git repository
5763
- Refreshes TMUX environment
5864

59-
`prefix + U`
65+
`prefix` + <kbd>U</kbd>
6066
- updates plugin(s)
6167

62-
`prefix + alt + u`
68+
`prefix` + <kbd>alt</kbd> + <kbd>u</kbd>
6369
- remove/uninstall plugins not on the plugin list
6470

6571
### More plugins
@@ -80,13 +86,15 @@ this:
8086

8187
### Tests
8288

83-
Tests for this project run on [travis](https://travis-ci.org/tmux-plugins/tpm).
89+
Tests for this project run on [Travis CI](https://travis-ci.org/tmux-plugins/tpm).
8490

8591
When run locally, [vagrant](https://www.vagrantup.com/) is required.
8692
Run tests with:
8793

88-
# within project directory
89-
$ ./run_tests
94+
```bash
95+
# within project directory
96+
$ ./run_tests
97+
```
9098

9199
### Other goodies
92100

0 commit comments

Comments
 (0)