Skip to content

Commit 24cb78c

Browse files
committed
chore: update readme
1 parent 62d71cb commit 24cb78c

File tree

1 file changed

+32
-18
lines changed

1 file changed

+32
-18
lines changed

readme.md

Lines changed: 32 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,13 @@
1-
# hyper-tabs-enhanced [![hyper](https://img.shields.io/badge/Hyper-v1.3.0-green.svg)](https://github.com/zeit/hyper/releases/tag/1.3.0) [![npm](https://img.shields.io/npm/v/hyper-tabs-enhanced.svg?maxAge=86400?style=flat-square)](https://www.npmjs.com/package/hyper-tabs-enhanced) [![npm](https://img.shields.io/npm/dt/hyper-tabs-enhanced.svg?maxAge=86400?style=flat-square)](https://www.npmjs.com/package/hyper-tabs-enhanced)
1+
# hyper-tabs-titles [![hyper](https://img.shields.io/badge/Hyper-v3.4.1-green.svg)](https://github.com/vercel/hyper/releases/tag/v3.4.1) [![npm](https://img.shields.io/npm/v/hyper-tabs-titles.svg?maxAge=43200?style=flat-square)](https://www.npmjs.com/package/hyper-tabs-titles)
22

3-
> Enhanced Tabs Plugin for [Hyper](https://hyper.is). Matches any theme.
4-
5-
![hyper-tabs-enhanced](https://cloud.githubusercontent.com/assets/1430576/22143133/35d9a170-def9-11e6-8d0f-047fb1c64e97.png)
3+
> Enhanced Tabs + Tabs Titles Plugin for [Hyper](https://hyper.is). Shows the current working directory in the tab title. Fork of [hyper-tabs-enhanced](https://github.com/henrikruscon/hyper-tabs-enhanced/)
64
5+
## Features
6+
- Show current working directory in tab title.
7+
- If number of open tabs is greater than N (3 by default), show only the last directory in path.
8+
- All features from [hyper-tabs-enhanced](https://github.com/henrikruscon/hyper-tabs-enhanced/)
9+
- Tab Icons
10+
- Colored Tabs, Tab Borders, Activity Pulse.
711

812
## Install
913

@@ -12,7 +16,7 @@ Add following to your `~/.hyper.js` config.
1216
```javascript
1317
module.exports = {
1418
...
15-
plugins: ['hyper-tabs-enhanced']
19+
plugins: ['hyper-tabs-titles']
1620
...
1721
}
1822
```
@@ -22,8 +26,23 @@ module.exports = {
2226

2327
Add following to `~/.hyper.js`
2428

25-
![hyper-tabs-enhanced-traffic](https://cloud.githubusercontent.com/assets/1430576/22143132/3578212a-def9-11e6-9e97-6d635bb89db8.png)
29+
### Configure threshold for shortening tab titles
30+
Default value is `3`. After this number of tabs are open, only the last directory in the path will be shown in tab titles.
31+
32+
```javascript
33+
module.exports = {
34+
config: {
35+
...
36+
hyperTabs: {
37+
openTabsThreshold: 3,
38+
}
39+
...
40+
}
41+
}
42+
```
43+
2644
### Enable Traffic Buttons
45+
![hyper-tabs-enhanced-traffic](https://cloud.githubusercontent.com/assets/1430576/22143132/3578212a-def9-11e6-9e97-6d635bb89db8.png)
2746
Default value is `false`
2847

2948
```javascript
@@ -38,8 +57,8 @@ module.exports = {
3857
}
3958
```
4059

41-
![hyper-tabs-enhanced-border](https://cloud.githubusercontent.com/assets/1430576/22143129/3508e06c-def9-11e6-973d-065a8e9b35f8.png)
4260
### Enable Border
61+
![hyper-tabs-enhanced-border](https://cloud.githubusercontent.com/assets/1430576/22143129/3508e06c-def9-11e6-973d-065a8e9b35f8.png)
4362
Default value is `false`
4463

4564
```javascript
@@ -54,8 +73,8 @@ module.exports = {
5473
}
5574
```
5675

57-
![hyper-tabs-enhanced-icons](https://cloud.githubusercontent.com/assets/1430576/22143130/3511b6e2-def9-11e6-90cc-b68425f71557.png)
5876
### Disable Tab Icons
77+
![hyper-tabs-enhanced-icons](https://cloud.githubusercontent.com/assets/1430576/22143130/3511b6e2-def9-11e6-90cc-b68425f71557.png)
5978
Default value is `true`
6079

6180
```javascript
@@ -70,8 +89,8 @@ module.exports = {
7089
}
7190
```
7291

73-
![hyper-tabs-enhanced-colored](https://cloud.githubusercontent.com/assets/1430576/22143128/35056cac-def9-11e6-8385-4fb572c5b08b.png)
7492
### Enable Colored Tab Icons
93+
![hyper-tabs-enhanced-colored](https://cloud.githubusercontent.com/assets/1430576/22143128/35056cac-def9-11e6-8385-4fb572c5b08b.png)
7594
Default value is `false`
7695

7796
```javascript
@@ -86,8 +105,8 @@ module.exports = {
86105
}
87106
```
88107

89-
![hyper-tabs-enhanced-activity](https://cloud.githubusercontent.com/assets/1430576/22143131/353d4f5a-def9-11e6-8b7b-6aa262b2c53b.png)
90108
### Change Activity Color
109+
![hyper-tabs-enhanced-activity](https://cloud.githubusercontent.com/assets/1430576/22143131/353d4f5a-def9-11e6-8b7b-6aa262b2c53b.png)
91110
Expected value is `CSS color`
92111

93112
```javascript
@@ -102,8 +121,8 @@ module.exports = {
102121
}
103122
```
104123

105-
![hyper-tabs-enhanced-align](https://user-images.githubusercontent.com/1430576/28241471-6679a506-6995-11e7-925d-e80c3f8178fe.png)
106124
### Align Close Button Right
125+
![hyper-tabs-enhanced-align](https://user-images.githubusercontent.com/1430576/28241471-6679a506-6995-11e7-925d-e80c3f8178fe.png)
107126
Default value is `'left'`
108127

109128
```javascript
@@ -133,10 +152,5 @@ module.exports = {
133152
}
134153
```
135154

136-
# Theme
137-
* [hyper-chesterish](https://github.com/henrikdahl/hyper-chesterish)
138-
139-
140-
## License
141-
142-
MIT © Henrik
155+
## Acknowledgements
156+
- This package is a fork of [hyper-tabs-enhanced](https://github.com/henrikruscon/hyper-tabs-enhanced/) by [henrikruscon](https://github.com/henrikruscon/) with added support for modifying tab titles.

0 commit comments

Comments
 (0)