From aebf333b0ce05bb6710729180335957ceed80dd4 Mon Sep 17 00:00:00 2001 From: Marco Zühlke Date: Sat, 19 Oct 2019 17:39:03 +0200 Subject: magic-enter: update README (#8284) --- plugins/magic-enter/Readme.md | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) (limited to 'plugins/magic-enter') diff --git a/plugins/magic-enter/Readme.md b/plugins/magic-enter/Readme.md index b401ab415..78514c67d 100644 --- a/plugins/magic-enter/Readme.md +++ b/plugins/magic-enter/Readme.md @@ -1,14 +1,17 @@ -## Magic Enter +## Magic Enter plugin -**Maintainer:** [@dufferzafar](https://github.com/dufferzafar) - -Makes your enter key magical, by binding commonly used commands to it. +This plugin makes your enter key magical, by binding commonly used commands to it. -You can set the commands to be run in your .zshrc, before the line containing plugins! +To use it, add `magic-enter` to the plugins array in your zshrc file. You can set the +commands to be run in your .zshrc, before the line containing plugins. If no command +is specified in a git directory, `git status` is executed; in other directories, `ls`. -```bash +```zsh +# defaults MAGIC_ENTER_GIT_COMMAND='git status -u .' MAGIC_ENTER_OTHER_COMMAND='ls -lh .' -plugins=(magic-enter) +plugins=(... magic-enter) ``` + +**Maintainer:** [@dufferzafar](https://github.com/dufferzafar) -- cgit v1.2.3-70-g09d2 From 67b5bfaaa316212221a01d4fe2eedcd0fc64c230 Mon Sep 17 00:00:00 2001 From: Marc Cornellà Date: Fri, 27 Dec 2019 02:37:27 +0100 Subject: Rename some plugin READMEs for consistency --- plugins/firewalld/README.md | 22 ++++++++++++++++++++++ plugins/firewalld/readme.md | 22 ---------------------- plugins/magic-enter/README.md | 17 +++++++++++++++++ plugins/magic-enter/Readme.md | 17 ----------------- plugins/ros/README.md | 10 ++++++++++ plugins/ros/README.mkd | 10 ---------- 6 files changed, 49 insertions(+), 49 deletions(-) create mode 100644 plugins/firewalld/README.md delete mode 100644 plugins/firewalld/readme.md create mode 100644 plugins/magic-enter/README.md delete mode 100644 plugins/magic-enter/Readme.md create mode 100644 plugins/ros/README.md delete mode 100644 plugins/ros/README.mkd (limited to 'plugins/magic-enter') diff --git a/plugins/firewalld/README.md b/plugins/firewalld/README.md new file mode 100644 index 000000000..8b5bc74d4 --- /dev/null +++ b/plugins/firewalld/README.md @@ -0,0 +1,22 @@ +# FirewallD Plugin + +This plugin adds some aliases and functions for FirewallD using the `firewalld-cmd` command. To use it, add firewalld to your plugins array. + +```zsh +plugins=(... firewalld) +``` + +## Aliases + +| Alias | Command | Description | +| :---- | :----------------------------------------- | :--------------------------- | +| fw | `sudo firewall-cmd` | Shorthand | +| fwr | `sudo firewall-cmd --reload` | Reload current configuration | +| fwp | `sudo firewall-cmd --permanent` | Create permanent rule | +| fwrp | `sudo firewall-cmd --runtime-to-permanent` | Save current configuration | + +## Functions + +| Function | Description | +| :------- | :--------------------------------------------------------- | +| fwl | Lists configuration from all active zones and direct rules | diff --git a/plugins/firewalld/readme.md b/plugins/firewalld/readme.md deleted file mode 100644 index 8b5bc74d4..000000000 --- a/plugins/firewalld/readme.md +++ /dev/null @@ -1,22 +0,0 @@ -# FirewallD Plugin - -This plugin adds some aliases and functions for FirewallD using the `firewalld-cmd` command. To use it, add firewalld to your plugins array. - -```zsh -plugins=(... firewalld) -``` - -## Aliases - -| Alias | Command | Description | -| :---- | :----------------------------------------- | :--------------------------- | -| fw | `sudo firewall-cmd` | Shorthand | -| fwr | `sudo firewall-cmd --reload` | Reload current configuration | -| fwp | `sudo firewall-cmd --permanent` | Create permanent rule | -| fwrp | `sudo firewall-cmd --runtime-to-permanent` | Save current configuration | - -## Functions - -| Function | Description | -| :------- | :--------------------------------------------------------- | -| fwl | Lists configuration from all active zones and direct rules | diff --git a/plugins/magic-enter/README.md b/plugins/magic-enter/README.md new file mode 100644 index 000000000..78514c67d --- /dev/null +++ b/plugins/magic-enter/README.md @@ -0,0 +1,17 @@ +## Magic Enter plugin + +This plugin makes your enter key magical, by binding commonly used commands to it. + +To use it, add `magic-enter` to the plugins array in your zshrc file. You can set the +commands to be run in your .zshrc, before the line containing plugins. If no command +is specified in a git directory, `git status` is executed; in other directories, `ls`. + +```zsh +# defaults +MAGIC_ENTER_GIT_COMMAND='git status -u .' +MAGIC_ENTER_OTHER_COMMAND='ls -lh .' + +plugins=(... magic-enter) +``` + +**Maintainer:** [@dufferzafar](https://github.com/dufferzafar) diff --git a/plugins/magic-enter/Readme.md b/plugins/magic-enter/Readme.md deleted file mode 100644 index 78514c67d..000000000 --- a/plugins/magic-enter/Readme.md +++ /dev/null @@ -1,17 +0,0 @@ -## Magic Enter plugin - -This plugin makes your enter key magical, by binding commonly used commands to it. - -To use it, add `magic-enter` to the plugins array in your zshrc file. You can set the -commands to be run in your .zshrc, before the line containing plugins. If no command -is specified in a git directory, `git status` is executed; in other directories, `ls`. - -```zsh -# defaults -MAGIC_ENTER_GIT_COMMAND='git status -u .' -MAGIC_ENTER_OTHER_COMMAND='ls -lh .' - -plugins=(... magic-enter) -``` - -**Maintainer:** [@dufferzafar](https://github.com/dufferzafar) diff --git a/plugins/ros/README.md b/plugins/ros/README.md new file mode 100644 index 000000000..83573e499 --- /dev/null +++ b/plugins/ros/README.md @@ -0,0 +1,10 @@ +# Roswell Plugin + +This plugin adds completions and aliases for [Roswell](https://github.com/roswell/roswell/). + +To use it, add `ros` to the plugins array in your zshrc file: + +```zsh +plugins=(... ros) +``` + diff --git a/plugins/ros/README.mkd b/plugins/ros/README.mkd deleted file mode 100644 index 83573e499..000000000 --- a/plugins/ros/README.mkd +++ /dev/null @@ -1,10 +0,0 @@ -# Roswell Plugin - -This plugin adds completions and aliases for [Roswell](https://github.com/roswell/roswell/). - -To use it, add `ros` to the plugins array in your zshrc file: - -```zsh -plugins=(... ros) -``` - -- cgit v1.2.3-70-g09d2