Skip to content

Commit 80f8110

Browse files
committed
Update doc.
1 parent e08669b commit 80f8110

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,15 @@
55
# multi-shell
66
> Managing multiple shell buffers.
77
8+
Simple and completely compatible to Emacs' built-in `shell` implementation.
9+
This also works with `eshell`.
10+
11+
12+
## Differences from other alternatives
13+
14+
* [mutli-term](https://www.emacswiki.org/emacs/MultiTerm)
15+
- Doesn't work in Windows.
16+
817

918
## Usage
1019

@@ -17,6 +26,25 @@
1726
* `multi-shell-kill` - Kill the current shell buffer.
1827
* `multi-shell-kill-all` - Kill the all shell buffers.
1928

29+
## Customization
30+
31+
Add these two lines in your configuration file if you do use any package
32+
management tool. (Like, [use-package](https://github.com/jwiegley/use-package))
33+
34+
```el
35+
(require 'multi-shell)
36+
(setq multi-shell-prefer-shell-type 'shell) ; Also accept `eshell`.
37+
```
38+
39+
If you are using [use-package](https://github.com/jwiegley/use-package)
40+
for package management.
41+
42+
```el
43+
(use-package multi-shell
44+
:init
45+
(setq multi-shell-prefer-shell-type 'shell)) ; Also accept `eshell`.
46+
```
47+
2048

2149
## Contribution
2250

0 commit comments

Comments
 (0)