update canary docs

readme.md

@@ -11,15 +11,13 @@
     </a>
 </p>
 
-> !!! You are looking at the canary branch. Documentation has not yet been updated on this branch and is NOT accurate.
-
 ## Usage
 
 ```lua
 use({
     'rose-pine/neovim',
     as = 'rose-pine',
-    -- tag = '...',
+	branch = 'canary',
     config = function()
         vim.cmd('colorscheme rose-pine')
     end
@@ -86,68 +84,42 @@ local colors = require("galaxyline.themes.colors")["rose-pine"]
 > Options should be set **before** colorscheme
 
 ```lua
--- set theme variant, matching terminal theme if unset
+require('rose-pine').setup({
--- @usage 'main' | 'moon' | 'dawn'
+	variant = 'main',
-vim.g.rose_pine_variant = ''
+	bold_vert_split = false,
+	dim_nc_background = false,
+	disable_background = false,
+	disable_float_background = false,
+	disable_italics = false,
+	---@usage string hex value or named color from rosepinetheme.com/palette
+	groups = {
+		border = 'highlight_med',
+		comment = 'muted',
+		link = 'iris',
+		punctuation = 'subtle',
 
-vim.g.rose_pine_bold_vertical_split_line = false
+		error = 'love',
-vim.g.rose_pine_disable_background = false
+		hint = 'iris',
-vim.g.rose_pine_disable_float_background = false
+		info = 'foam',
-vim.g.rose_pine_disable_italics = false
+		warn = 'gold',
-vim.g.rose_pine_inactive_background = false
 
-local palette = require('rose-pine.palette')
+		headings = {
-vim.g.rose_pine_colors = {
+			h1 = 'iris',
-	border = palette.highlight_med,
+			h2 = 'foam',
-	comment = palette.muted,
+			h3 = 'rose',
-	link = palette.iris,
+			h4 = 'gold',
-	punctuation = palette.subtle,
+			h5 = 'pine',
-
+			h6 = 'foam',
-	error = palette.love,
+		}
-	hint = palette.iris,
+		-- or set all headings at once
-	info = palette.foam,
+		-- headings = 'subtle'
-	warn = palette.gold,
+	}
-
+})
-	git_add = palette.foam,
-	git_change = palette.rose,
-	git_delete = palette.love,
-	git_dirty = palette.rose,
-	git_ignore = palette.muted,
-	git_merge = palette.iris,
-	git_rename = palette.pine,
-	git_stage = palette.iris,
-	git_text = palette.rose,
-
-	-- or set all headings to one colour: `headings = palette.text`
-	headings = {
-		h1 = palette.iris,
-		h2 = palette.foam,
-		h3 = palette.rose,
-		h4 = palette.gold,
-		h5 = palette.pine,
-		h6 = palette.foam,
-	},
-}
 
 -- Set colorscheme after options
 vim.cmd('colorscheme rose-pine')
 ```
 
-## Suggested keymaps
-
-```lua
--- toggle between all variants
-vim.keymap.set('n', '<leader>tt', require('rose-pine').toggle)
-
--- or toggle between some variants
-vim.keymap.set('n', '<leader>tt', function() return require('rose-pine').toggle({'moon', 'dawn'}) end)
-
--- set variant
-vim.keymap.set('n', '<leader>t1', function() return require('rose-pine').set('main') end)
-vim.keymap.set('n', '<leader>t2', function() return require('rose-pine').set('moon') end)
-vim.keymap.set('n', '<leader>t3', function() return require('rose-pine').set('dawn') end)
-```
-
 ## Contributing
 
 We welcome and appreciate any help in creating a lovely experience for all.