From 53d987346f4d465c100f3dab234953db48eed7a1 Mon Sep 17 00:00:00 2001
From: Erwan ROUSSEL <erwan.roussel51@gmail.com>
Date: Sat, 5 Oct 2019 11:30:21 +0200
Subject: [PATCH 1/2] Create README.md

---
 plugins/perl/README.md | 36 ++++++++++++++++++++++++++++++++++++
 1 file changed, 36 insertions(+)
 create mode 100644 plugins/perl/README.md

diff --git a/plugins/perl/README.md b/plugins/perl/README.md
new file mode 100644
index 000000000..f2f4b79ec
--- /dev/null
+++ b/plugins/perl/README.md
@@ -0,0 +1,36 @@
+# Perl
+
+This plugin adds [perl](https://www.perl.org/) useful aliases/functions.
+
+To use it, add `perl` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... perl)
+```
+
+## Aliases
+
+| Aliases       | Command         | Description                          |
+| :------------ | :-------------- | :----------------------------------- |
+| pbi           | perlbrew install|Install specific perl version         |
+| pbl           | perlbrew list   |List all perl version installed       |
+| pbo           | perlbrew off    |Go back to the system perl            |
+| pbs           | perlbrew switch |Turn it back on                       |
+| pbu           | perlbrew use    |Use specific version of perl          |
+| pd            | perldoc         |Show the perl documentation          |
+| ple           | perl -wlne      |Use perl like awk/sed                 |
+| latest-perl   | curl `...`      |Show the latest stable release of Perl|
+
+## Functions
+
+`newpl` - creates a basic Perl script file and opens it with $EDITOR
+
+`pgs` - Perl Global Substitution (find pattern = 1st arg ; replace pattern	= 2nd arg ; filename = 3rd arg)
+
+`prep` - Perl grep, because 'grep -P' is terrible. Lets you work with pipes or files. (pattern = 1st arg ; filename = 2nd arg)
+
+## Requirements
+
+In order to make this work, you will need to have perl installed.
+
+More info on the usage and install: https://www.perl.org/get.html

From 896dd271c8cadce8b8a618225cb4e79b9bca50f7 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Marc=20Cornell=C3=A0?= <marc.cornella@live.com>
Date: Mon, 7 Oct 2019 17:40:51 +0200
Subject: [PATCH 2/2] Some syntax changes and more function docs

---
 plugins/perl/README.md | 29 +++++++++++++++--------------
 1 file changed, 15 insertions(+), 14 deletions(-)

diff --git a/plugins/perl/README.md b/plugins/perl/README.md
index f2f4b79ec..dd9b7dc75 100644
--- a/plugins/perl/README.md
+++ b/plugins/perl/README.md
@@ -10,27 +10,28 @@ plugins=(... perl)
 
 ## Aliases
 
-| Aliases       | Command         | Description                          |
-| :------------ | :-------------- | :----------------------------------- |
-| pbi           | perlbrew install|Install specific perl version         |
-| pbl           | perlbrew list   |List all perl version installed       |
-| pbo           | perlbrew off    |Go back to the system perl            |
-| pbs           | perlbrew switch |Turn it back on                       |
-| pbu           | perlbrew use    |Use specific version of perl          |
-| pd            | perldoc         |Show the perl documentation          |
-| ple           | perl -wlne      |Use perl like awk/sed                 |
-| latest-perl   | curl `...`      |Show the latest stable release of Perl|
+| Aliases       | Command            |  Description                           |
+| :------------ | :----------------- | :------------------------------------- |
+| pbi           | `perlbrew install` | Install specific perl version          |
+| pbl           | `perlbrew list`    | List all perl version installed        |
+| pbo           | `perlbrew off`     | Go back to the system perl             |
+| pbs           | `perlbrew switch`  | Turn it back on                        |
+| pbu           | `perlbrew use`     | Use specific version of perl           |
+| pd            | `perldoc`          | Show the perl documentation            |
+| ple           | `perl -wlne`       | Use perl like awk/sed                  |
+| latest-perl   | `curl ...`         | Show the latest stable release of Perl |
 
 ## Functions
 
-`newpl` - creates a basic Perl script file and opens it with $EDITOR
+* `newpl`: creates a basic Perl script file and opens it with $EDITOR.
 
-`pgs` - Perl Global Substitution (find pattern = 1st arg ; replace pattern	= 2nd arg ; filename = 3rd arg)
+* `pgs`: Perl Global Substitution: `pgs <find_pattern> <replace_pattern> <filename>`
+  Looks for `<find_pattern>` and replaces it with `<replace_pattern>` in `<filename>`.
 
-`prep` - Perl grep, because 'grep -P' is terrible. Lets you work with pipes or files. (pattern = 1st arg ; filename = 2nd arg)
+* `prep`: Perl grep, because 'grep -P' is terrible: `prep <pattern> [<filename>]`
+  Lets you work with pipes or files (if no `<filename>` provided, use stdin).
 
 ## Requirements
 
 In order to make this work, you will need to have perl installed.
-
 More info on the usage and install: https://www.perl.org/get.html