Skip to content

Commit f2ebfc5

Browse files
committed
readme
1 parent dee78bf commit f2ebfc5

File tree

1 file changed

+27
-5
lines changed

1 file changed

+27
-5
lines changed

README.md

+27-5
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,26 @@ You can **fuzzy find your text** instead of selecting it by hand:
1717
Use it for paths, URLs, options from a man page, git hashes, docker container names, ...
1818

1919

20+
- [Requirements](#requirements)
21+
- [Installation](#installation)
22+
- [Using Tmux Plugin Manager](#using-tmux-plugin-manager)
23+
- [Manual Method](#manual-method)
24+
- [Wiki](#wiki)
25+
- [Options](#options)
26+
- [Common Options](#common-options)
27+
- [Keys](#keys)
28+
- [Advanced Options](#advanced-options)
29+
- [Using skim instead of fzf](#using-skim-instead-of-fzf)
30+
- [Examples](#examples)
31+
- [Custom Tmux Keybindings](#custom-tmux-keybindings)
32+
- [Custom Filters](#custom-filters)
33+
- [](#)
34+
- [CLI tool](#cli-tool)
35+
- [Installation](#installation)
36+
- [Usage](#usage)
37+
- [Contributions](#contributions)
38+
39+
2040
## Requirements
2141

2242
<a href="https://github.com/laktak/tome"><img src="https://github.com/laktak/tome/wiki/assets/clippy_tome.gif" align="right" alt="clippy" width="265" height="349"></a>
@@ -25,6 +45,7 @@ Use it for paths, URLs, options from a man page, git hashes, docker container na
2545
- [fzf](https://github.com/junegunn/fzf) or [skim](https://github.com/skim-rs/skim) (see below)
2646
- Python 3.6+
2747
- a posix shell like Bash
48+
- optionally [Tmux Plugin Manager](https://github.com/tmux-plugins/tpm)
2849

2950
Supported clipboards:
3051

@@ -36,7 +57,7 @@ Supported clipboards:
3657

3758
## Installation
3859

39-
### Using [Tmux Plugin Manager](https://github.com/tmux-plugins/tpm)
60+
### Using Tmux Plugin Manager
4061

4162
Add the plugin to the list of TPM plugins in `.tmux.conf`:
4263

@@ -171,11 +192,11 @@ See [extrakto.conf](extrakto.conf) for syntax and predefined filters.
171192

172193
---
173194

174-
# CLI
195+
## CLI tool
175196

176197
You can also use extrakto as a standalone tool to extract tokens from text.
177198

178-
## Installation
199+
### Installation
179200

180201
For now simply clone the repository and link to the tool somewhere in your path:
181202

@@ -188,7 +209,7 @@ ln -s $PWD/extrakto.py ~/.local/bin/extrakto
188209

189210
Requires Python 3.6+.
190211

191-
## CLI Usage
212+
### Usage
192213

193214
```
194215
usage: extrakto.py [-h] [--name] [-w] [-l] [--all] [-a ADD] [-p] [-u] [--alt] [-r] [-m MIN_LENGTH] [--warn-empty]
@@ -211,10 +232,11 @@ optional arguments:
211232
--warn-empty warn if result is empty
212233
```
213234

214-
# Contributions
235+
## Contributions
215236

216237
Thanks go to all contributors for their ideas and PRs!
217238

218239
**If you make a PR, please keep it small so that it's easier to test and review. Try to create one PR per feature/bug.**
219240

220241
Please run `black` if you change any python code and run `shfmt -p` if you change any shell files.
242+

0 commit comments

Comments
 (0)