Update README

This commit is contained in:
Alex Yatskov 2023-02-20 18:12:46 -08:00
parent a67adc94a3
commit bb3861f436

View File

@ -22,13 +22,13 @@ require('guid').setup({
These options are: These options are:
* `comma_space` \ #### `comma_space`
Specifies if commas should be followed by spaces in GUIDs formatted with the `x` and `X` specifiers. Specifies if commas should be followed by spaces in GUIDs formatted with the `x` and `X` specifiers.
* `default_style` \ #### `default_style`
Specifies which format to use if one is not provided for `GuidInsert` and `GuidFormat` commands. Specifies which format to use if one is not provided for `GuidInsert` and `GuidFormat` commands.
* `object-char` \ #### `object_char`
Specifies which character should be used for the GUID text object. Specifies which character should be used for the GUID text object.
## GUID Formatting ## GUID Formatting
@ -52,13 +52,13 @@ GUID text representation. The case of the format specifier determines whether lo
## GUID Commands ## GUID Commands
* `GuidInsert [format]` \ #### `GuidInsert [format]`
Inserts a GUID at the cursor position using the default or provided format. Inserts a GUID at the cursor position using the default or provided format.
* `GuidFormat [format]` \ #### `GuidFormat [format]`
Formats the GUID at the cursor position using the default or provided format. Formats the GUID at the cursor position using the default or provided format.
* `GuidObject` \ #### `GuidObject`
Selects the GUID at the cursor position (useful for text objects). Selects the GUID at the cursor position (useful for text objects).
## GUID Text Object ## GUID Text Object