-
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #14 from Cassin01/update
- Loading branch information
Showing
30 changed files
with
1,811 additions
and
1,790 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
Wf.disable() wf.txt /*Wf.disable()* | ||
Wf.enable() wf.txt /*Wf.enable()* | ||
Wf.options wf.txt /*Wf.options* | ||
Wf.setup() wf.txt /*Wf.setup()* | ||
Wf.toggle() wf.txt /*Wf.toggle()* |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
============================================================================== | ||
------------------------------------------------------------------------------ | ||
*Wf.options* | ||
`Wf.options` | ||
Your plugin configuration with its default values. | ||
|
||
Default values: | ||
> | ||
Wf.options = { | ||
-- Prints useful logs about what event are triggered, and reasons actions are executed. | ||
debug = false, | ||
} | ||
< | ||
|
||
------------------------------------------------------------------------------ | ||
*Wf.setup()* | ||
`Wf.setup`({options}) | ||
Define your wf setup. | ||
|
||
Parameters~ | ||
{options} `(table)` Module config table. See |Wf.options|. | ||
|
||
Usage~ | ||
`require("wf").setup()` (add `{}` with your |Wf.options| table) | ||
|
||
|
||
============================================================================== | ||
------------------------------------------------------------------------------ | ||
*Wf.toggle()* | ||
`Wf.toggle`() | ||
Toggle the plugin by calling the `enable`/`disable` methods respectively. | ||
|
||
------------------------------------------------------------------------------ | ||
*Wf.enable()* | ||
`Wf.enable`() | ||
A method to enable your plugin. | ||
|
||
------------------------------------------------------------------------------ | ||
*Wf.disable()* | ||
`Wf.disable`() | ||
A method to disable your plugin. | ||
|
||
|
||
vim:tw=78:ts=8:noet:ft=help:norl: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.