Add README.md

README.md

@@ -0,0 +1,42 @@
+# telescope-orgmode.nvim
+
+Integration for [orgmode](https://github.com/nvim-orgmode/orgmode) with
+[telescope.nvim](https://github.com/nvim-telescope/telescope.nvim).
+
+## Demo
+
+TODO
+
+## Setup
+
+You can setup the extension by doing:
+
+```lua
+require('telescope').load_extension('orgmode')
+```
+
+To replace the default refile prompt:
+
+```lua
+vim.api.nvim_create_autocmd('FileType', {
+  pattern = 'org',
+  group = vim.api.nvim_create_augroup('orgmode_telescope_nvim', { clear = true })
+  callback = function()
+    vim.keymap.set('n', '<leader>or', require('telescope').extensions.orgmode.refile_heading)
+  end,
+})
+```
+
+## Available commands
+
+```viml
+:Telescope orgmode search_headings
+:Telescope orgmode refile_heading
+```
+
+## Available functions
+
+```lua
+require('telescope').extensions.orgmode.search_headings
+require('telescope').extensions.orgmode.refile_heading
+```