From: Raphaël Gertz <git@rapsys.eu>
Date: Mon, 3 Oct 2022 04:05:57 +0000 (+0200)
Subject: Add readme
X-Git-Tag: 0.2~2
X-Git-Url: https://git.rapsys.eu/packer/commitdiff_plain/f2d7af80257a81938acc690ab88be617a13e6880

Add readme
---

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..78449eb
--- /dev/null
+++ b/README.md
@@ -0,0 +1,65 @@
+Contribute
+==========
+
+You may buy me a Beer, a Tea or help with Server fees with a paypal donation to
+the address <paypal@rapsys.eu>.
+
+Don't forget to show your love for this project, feel free to report bugs to
+the author, issues which are security relevant should be disclosed privately
+first.
+
+Patches are welcomed and grant credit when requested.
+
+Installation
+============
+
+Install local binary
+--------------------
+
+You need to have cpack and jpack scripts from this repository
+set as executable and installed in /usr/local/bin.
+
+### Step 1: Install the required perl packages
+
+To install cpack and jpack required packages open a root console and execute
+the following command:
+
+```console
+# urpmi perl-base perl-CSS-Packer perl-JavaScript-Packer
+```
+
+or stone age distributions:
+
+```console
+# apt-get install libcss-packer-perl libjavascript-packer-perl
+```
+
+or other distributions through cpan:
+
+```console
+# cpan App::cpanminus
+# cpanm CSS::Packer
+# cpanm JavaScript::Packer
+```
+
+### Step 2: Install the binaries
+
+To install cpack and jpack binaries open a root console and execute the
+following command:
+
+```console
+# cp cpack jpack /usr/local/bin/
+```
+
+Use local binary
+----------------
+
+To use local binaries you may execute the following commands:
+
+```console
+# cpack < input.css > output.css
+```
+
+```console
+# jpack < input.js > output.js
+```