Edited the help text to make it clearer and more complete

This commit is contained in:
pezcurrel 2024-09-28 21:02:29 +02:00
parent eb9fd01489
commit e34b99fd1e

View file

@ -17,7 +17,7 @@
*/
$SCRIPTNAME='pfaltgall';
$SCRIPTVERSION='0.1';
$SCRIPTVERSION='0.2';
require 'lib/ckratelimit.php';
require 'lib/httpjson.php';
@ -38,11 +38,14 @@ $help=
[[[ DESCRIPTION ]]]
This is {$SCRIPTNAME} v{$SCRIPTVERSION}, a CLI PHP script that can generate an html file with
a gallery from your Pixelfed profile, preserving each posts content and
possible image descriptions (alt-texts).
In order to create it, you just need to login to your Pixelfed account and
get an app token (Settings -> Applications -> Create new token), then create
a configuration file for {$SCRIPTNAME} like this (dont write the «---» lines):
a gallery from your Pixelfed profile. The gallery loads each image
dynamically, displays it using almost all the available screen space and lets
you jump right from the start to any point in the timeline. It also preserves
each posts text content and any possible image description (alt-text).
In order to create the html gallery file, you just need to login to your
Pixelfed account and get an app token (Settings -> Applications -> Create new
token), then create a configuration file for {$SCRIPTNAME} like this (dont write
the «---» lines):
---
host=your_instance_host
@ -60,7 +63,7 @@ token=as7f8a7s0d89f7as97df09a8s7d90f81jkl2h34lkj12h3jkl4
and the path of an output file as arguments (if the output file exists, it
will be overwritten) - e.g.: «{$SCRIPTNAME} goofy@pixelfed.social.conf index.html».
This will create an html file that will be ready to be put where you want
(you can also see it locally, obviously).
(youll also be able to see it locally, obviously).
[[[ OPTIONS ]]]