added gif

caenrique · Apr 17, 2020 · 64bcf27 · 64bcf27
1 parent 291a676
commit 64bcf27
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,25 @@
+Toggles between the current window and the current buffer opened in a new tab page.
+
+![](maximize-window-example.gif)
+
+## Command
+
+```vim
+:ToggleOnly
+```
+
+You have to define your own key bindings. For example:
+
+```vim
+nnoremap <leader>o :ToggleOnly<Enter>
+```
+
+## Installation
+
+Use your favourite plugin manager. For example, using [Plug](https://github.com/junegunn/vim-plug):
+
+```vim
+call plug#begin()
+Plug 'caenrique/nvim-maximize-window-toggle'
+call plug#end()
+```
diff --git a/autoload/nvim-maximize-window-toggle.vim b/autoload/nvim-maximize-window-toggle.vim
@@ -1,9 +1,7 @@
 ""
 " @public
-" If the current tab page has more than one window,
-" opens the current buffer alone in a new tab.
-" Calling this function again in the new window will
-" close the tab and go back to the original window
+" Toggles between the current window and the current buffer
+" opened in a new tab page.
 ""
 function! nvim_maximize_window_toggle#ToggleOnly()
   if winnr("$") > 1

diff --git a/maximize-window-example.gif b/maximize-window-example.gif