53d987346f4d465c100f3dab234953db48eed7a1

Author
Erwan ROUSSEL <erwan.roussel51@gmail.com>
Committer
GitHub <noreply@github.com>
Date

Message

Create README.md

Diff

 1diff --git a/plugins/perl/README.md b/plugins/perl/README.md
 2new file mode 100644
 3index 0000000000000000000000000000000000000000..f2f4b79ec27489339d229b4f82370b797899606f
 4--- /dev/null
 5+++ b/plugins/perl/README.md
 6@@ -0,0 +1,36 @@
 7+# Perl
 8+
 9+This plugin adds [perl](https://www.perl.org/) useful aliases/functions.
10+
11+To use it, add `perl` to the plugins array in your zshrc file:
12+
13+```zsh
14+plugins=(... perl)
15+```
16+
17+## Aliases
18+
19+| Aliases       | Command         | Description                          |
20+| :------------ | :-------------- | :----------------------------------- |
21+| pbi           | perlbrew install|Install specific perl version         |
22+| pbl           | perlbrew list   |List all perl version installed       |
23+| pbo           | perlbrew off    |Go back to the system perl            |
24+| pbs           | perlbrew switch |Turn it back on                       |
25+| pbu           | perlbrew use    |Use specific version of perl          |
26+| pd            | perldoc         |Show the perl documentation          |
27+| ple           | perl -wlne      |Use perl like awk/sed                 |
28+| latest-perl   | curl `...`      |Show the latest stable release of Perl|
29+
30+## Functions
31+
32+`newpl` - creates a basic Perl script file and opens it with $EDITOR
33+
34+`pgs` - Perl Global Substitution (find pattern = 1st arg ; replace pattern	= 2nd arg ; filename = 3rd arg)
35+
36+`prep` - Perl grep, because 'grep -P' is terrible. Lets you work with pipes or files. (pattern = 1st arg ; filename = 2nd arg)
37+
38+## Requirements
39+
40+In order to make this work, you will need to have perl installed.
41+
42+More info on the usage and install: https://www.perl.org/get.html