Skip to content

Commit 894400f

Browse files
committed
doc: misc. readme improvements
- Make the asciicast less aggressive - Fix misaligned badges on official website - Typo
1 parent 830d62b commit 894400f

File tree

1 file changed

+11
-2
lines changed

1 file changed

+11
-2
lines changed

README.md

+11-2
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,22 @@ tags:
1212
- Plugin
1313
---
1414
{{< github_badge >}}
15+
16+
{{< rawhtml >}}
17+
<div class="badges">
18+
{{< /rawhtml >}}
1519
end_insert -->
1620
<!-- remove -->
1721
# 🦘 telescope-repo.nvim: jump around the repositories in your filesystem, without any setup
1822
<!-- end_remove -->
1923

2024
![Neovim version](https://img.shields.io/badge/Neovim-0.5-57A143?style=flat&logo=neovim) [![](https://img.shields.io/badge/powered%20by-riss-lightgrey)](https://cj.rs/riss)
2125

26+
<!-- insert
27+
{{< rawhtml >}}
28+
</div>
29+
{{< /rawhtml >}}
30+
end_insert -->
2231

2332
`telescope-repo` is an extension for [telescope.nvim][] that searches the filesystem for *git* (or other SCM[^1], like *Pijul*, *Mercurial*…) repositories. It does not require any setup: the list of repositories is built on the fly over your whole `$HOME`, you don’t need to manually add projects or open some folders to populate this list, as opposed to [telescope-project.nvim](https://github.com/nvim-telescope/telescope-project.nvim) or [project.nvim](https://github.com/ahmedkhalf/project.nvim).
2433

@@ -28,13 +37,13 @@ end_insert -->
2837
<!-- insert
2938
Finding the repositories with “telescope” in their name, with the README in the panel on the top:
3039
31-
{{< asciicast src="/telescope-repo-nvim/telescope.json" poster="npt:0:04" autoplay="false" loop="false" >}}
40+
{{< asciicast src="/telescope-repo-nvim/telescope.json" preload=1 loop="true" start-at="1" >}}
3241
end_insert -->
3342

3443
Use cases include:
3544
* If you don’t start vim from the shell (from a GUI or as the start command of a terminal), you are most likely in your `$HOME` directory. You then want to jump into your code as quickly as possible and this plugin can help!
3645
* Sometimes, you have the definition of a function and use of it in different repositories (e.g. a library you wrote and a program using this library). This plugin helps to open the two, for instance in two splits.
37-
* Use of less popular SCMs: some similar extensions rely on strong conventions to find repositories, like “directories containing a `.git` file that is also a directory, all inside directory `X`”. Less popular SCMs like [Pijul][] have a different folder name, and even [`git worktree`s][worktree] don’t feat neatly into these constraint, with their `.git` *files*.
46+
* Use of less popular SCMs: some similar extensions rely on strong conventions to find repositories, like “directories containing a `.git` file that is also a directory, all inside directory `X`”. Less popular SCMs like [Pijul][] have a different folder name, and even [`git worktree`][worktree]s don’t fit neatly into these constraint, with their `.git` *files*.
3847

3948
[telescope.nvim]: https://github.com/nvim-telescope/telescope.nvim
4049
[Pijul]: https://pijul.org/

0 commit comments

Comments
 (0)