aboutsummaryrefslogtreecommitdiff
path: root/README.txt
diff options
context:
space:
mode:
authorziggys <ziggys@autistici.org>2018-06-10 17:11:07 -0400
committerziggys <ziggys@autistici.org>2018-06-10 17:11:07 -0400
commit0b65462c3bcb1b5f318c6f7e98154cb34b8063a1 (patch)
tree7e07dc7c6b04f998c372757dbbcfe02b60d26768 /README.txt
parente950dc73c75511fc7c54fdb07e987ab2dd74aa7e (diff)
downloadpupm-0b65462c3bcb1b5f318c6f7e98154cb34b8063a1.tar
pupm-0b65462c3bcb1b5f318c6f7e98154cb34b8063a1.zip
Check some sytax and fix minor bugs
Diffstat (limited to 'README.txt')
-rw-r--r--README.txt42
1 files changed, 29 insertions, 13 deletions
diff --git a/README.txt b/README.txt
index 91a39c9..02978cb 100644
--- a/README.txt
+++ b/README.txt
@@ -1,29 +1,45 @@
Properly Update Prosody Modules
+-------------------------------
+A very simple way to update core and community modules for prosody xmpp server
+from official modules repository (https://hg.prosody.im/prosody-modules).
-Simply update core and community prosody xmpp server modules to last version
-in official modules repository (https://hg.prosody.im/prosody-modules).
+Install
+-------
+Script doesn't requires installation, simply download the script into the host
+where prosody is running, configure and execute with root privileges.
-Download the script into your localhost and execute (need root access).
+~$ git clone https://git.p4g.club/git/pupm.git pupm
-Run it:
+Execute
+-------
+Change to 'pupm' directory and run script:
-./pupm.sh <config>
+~$ cd pupm && ./pupm.sh pupm.config
-./pupm.sh pupm.config
+Run with no arguments to show help.
-Run it with no arguments for help.
+~$ cd pupm && ./pupm.sh
-Config example is provided within repository
+----------------
+pupm.shh version 3.0.2
+ Copyright (C) 2018 by
+
+pupm.sh comes with ABSOLUTELY NO WARRANTY. This is free software, and you
+ are welcome to redistribute it under certain conditions. See the BSD 2.0
+ license for details
+
+pupm.sh is a simple shellscript to properly update prosody modules
+
+Usage: ./pupm.sh <configfile>
+
+Usage: ./pupm.sh pupm.config
+----------------
-STDOUT and STDERR will be logged in '/tmp/pupm.log'. Cronjob can be configued
-easyly. Use '/tmp/pupm.log' as inputfile for sending notifications with
-appropiate tools.
+Config example is provided within repository.
-# TODO
-# check syntax