diff --git a/README.md b/README.md index 2dbf7ad..dc7e632 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,19 @@ ```text [[[ SYNOPSIS ]]] - pfaltgall [options] + pfaltgall [options] [[[ DESCRIPTION ]]] - This is pfaltgall v0.1, a CLI PHP script that can generate an html file with -a gallery from your Pixelfed profile. - 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 pfaltgall like this (don’t write the «---» lines): + This is pfaltgall v0.2, a CLI PHP script that can generate an html file with +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 post’s 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 pfaltgall like this (don’t write +the «---» lines): --- host=your_instance_host @@ -23,9 +27,11 @@ host=pixelfed.social token=as7f8a7s0d89f7as97df09a8s7d90f81jkl2h34lkj12h3jkl4 --- - Then run pfaltgall with the path of the configuration file you have -created. This will create an «index.html» file that will be ready to be put -where you want (you can also see it locally, obviously). + Then run pfaltgall with the path of the configuration file you have created +and the path of an output file as arguments (if the output file exists, it +will be overwritten) - e.g.: «pfaltgall goofy@pixelfed.social.conf index.html». + This will create an html file that will be ready to be put where you want +(you’ll also be able to see it locally, obviously). [[[ OPTIONS ]]]