improve docs

Author: sullivan-sean

.gitignore

@@ -1 +1,2 @@
 bin/
+doc/tags

README.md

@@ -8,8 +8,26 @@ least 0.6)
 2.  Install `Exafunction/codeium.vim` using your vim plugin manager of
 choice, or manually. See [Installation Options](#installation-options) below.
 
-3. Run `:CodeiumAuth` to set up the plugin and start using Codeium.
+3. Run `:Codeium Auth` to set up the plugin and start using Codeium.
 
+You can run `:help codeium` for a full list of commands and configuration
+options.
+
+## Configuration
+
+Codeium can be disabled for particular filetypes by setting the
+`g:codeium_filetypes` variable in your vim config file (vimrc/init.vim):
+
+```
+let g:codeium_filetypes = {
+    \ "bash": v:false,
+    \ "typescript": v:true,
+    \ }
+```
+
+Codeium is enabled by default for most filetypes.
+
+For a full list of configuration options you can run `:help codeium`.
 
 ## Installation Options
 

autoload/codeium.vim

@@ -22,9 +22,9 @@ function! codeium#Enabled() abort
       return v:false
   endif
 
-  let codeium_enabled_languages = s:default_codeium_enabled
-  call extend(codeium_enabled_languages, get(g:, 'codeium_enabled_languages', {}))
-  if !get(codeium_enabled_languages, &ft, 1)
+  let codeium_filetypes = s:default_codeium_enabled
+  call extend(codeium_filetypes, get(g:, 'codeium_filetypes', {}))
+  if !get(codeium_filetypes, &ft, 1)
     return v:false
   endif
 

autoload/codeium/server.vim

@@ -1,6 +1,25 @@
-let s:codeium_version = '1.0.0'
-let s:ide = 'jetbrains'
-let s:ide_version = '1.0.0'
+let s:language_server_version = '1.1.14'
+
+if has('nvim')
+  let s:ide = 'neovim'
+else 
+  let s:ide = 'vim'
+endif
+
+if !exists('s:editor_version')
+  if has('nvim')
+    let s:ide_version = matchstr(execute('version'), 'NVIM v\zs[^[:space:]]\+')
+  else
+    let major = v:version / 100
+    let minor = v:version % 100
+    if exists('v:versionlong')
+      let patch = printf('%04d', v:versionlong % 1000)
+      let s:ide_version =  major . '.' . minor . '.' . patch
+    else
+      let s:ide_version =  major . '.' . minor
+    endif
+  endif
+endif
 
 let s:server_port = v:null
 let s:server_job = v:null
@@ -34,7 +53,7 @@ function! codeium#server#RequestMetadata() abort
         \ "api_key": codeium#command#ApiKey(),
         \ "ide_name":  s:ide,
         \ "ide_version":  s:ide_version,
-        \ "extension_version":  s:codeium_version,
+        \ "extension_version":  s:language_server_version,
         \ }
 endfunction
 
@@ -113,7 +132,7 @@ function! codeium#server#Start() abort
   endif
 
   if empty(glob(bin))
-    let url = 'https://github.com/Exafunction/codeium/releases/download/language-server-v1.1.14/language_server_' . bin_suffix . '.gz'
+    let url = 'https://github.com/Exafunction/codeium/releases/download/language-server-v' . s:language_server_version . '/language_server_' . bin_suffix . '.gz'
     call system('curl -Lo ' . bin . '.gz' . ' ' . url)
     call system('gzip -d ' . bin . '.gz')
     call system('chmod +x ' . bin)

doc/codeium.txt

@@ -0,0 +1,81 @@
+*codeium.txt*  Codeium
+
+GETTING STARTED                                 *codeium*
+
+Run the `:Codeium Auth` command to login to Codeium. This is required to
+enable the plugin.
+
+Once logged in, suggested completions will be displayed inline as virtual
+text. You can insert a completion by pressing <Tab>.
+
+COMMANDS                                        *:Codeium*
+
+                                                *:Codeium_Auth*
+:Codeium Auth           Authenticate to Codeium.
+
+                                                *:Codeium_Disable*
+:Codeium Disable        Disable Codeium completions
+
+                                                *:Codeium_Enable*
+:Codeium Enable         Re-enable Codeium completions after running :Codeium Disable
+
+                                                *:Codeium_DisableBuffer*
+:Codeium DisableBuffer  Disable Codeium completions in the current buffer only.
+
+                                                *:Codeium_EnableBuffer*
+:Codeium EnableBuffer   Re-eisable Codeium completions in the current
+                        buffer after running :Codeium DisableBuffer
+
+
+OPTIONS                                         *codeium-options*
+
+                                                *g:codeium_filetypes*
+g:codeium_filetypes     A dictionary mapping whether codeium should be
+                        enabled or disabled in certain filetypes. This can
+                        be used to opt out of completions for certain filetypes.
+>
+                        let g:codeium_filetypes = {
+                              \ 'bash': v:false,
+                              \ 'typescript': v:true,
+                              \ }
+<
+
+                                                *g:codeium_filetypes*
+g:codeium_enabled       A global boolean flag that controls whether codeium
+                        completions are enabled or disabled by default.
+>
+                        let g:codeium_enabled = v:true
+<
+
+MAPS                                            *codeium-maps*
+
+                                                *codeium-i_<Tab>*
+Codeium.vim defaults to using the <Tab> key to insert the current
+suggestion. If there is no suggestion display, the <Tab> key will fallback
+to any existing <Tab> mapping you have.
+
+Other Maps ~
+
+                                                *codeium-i_CTRL-]*
+<C-]>                   Dismiss the current suggestion.
+<Plug>(codeium-dismiss)
+
+                                                *codeium-i_ALT-]*
+<M-]>                   Cycle to the next suggestion.
+<Plug>(codeium-next)
+
+                                                *codeium-i_ALT-[*
+<M-[>                   Cycle to the previous suggestion.
+<Plug>(codeium-previous)
+
+SYNTAX HIGHLIGHTING                             *codeium-highlighting*
+
+Inline suggestions are highlighted using the CodeiumSuggestion group,
+which defaults to a gray color. You can configure this highlight group for
+your colorscheme in after/colors/<colorschemename>.vim in your
+'runtimepath' (e.g., ~/.config/nvim/after/colors/solarized.vim).  Example
+declaration:
+>
+        highlight CodeiumSuggestion guifg=#555555 ctermfg=8
+<
+ vim:tw=78:et:ft=help:norl:

plugin/codeium.vim

@@ -53,3 +53,8 @@ endif
 
 call s:SetStyle()
 call codeium#server#Start()
+
+let s:dir = expand('<sfile>:h:h')
+if getftime(s:dir . '/doc/codeium.txt') > getftime(s:dir . '/doc/tags')
+  silent! execute 'helptags' fnameescape(s:dir . '/doc')
+endif