diff --git a/README.md b/README.md index cf5708e..60153f9 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,51 @@ -# fediverso-box +# Fediverso Box -Plugin WordPress per mostrare un box per seguire l'autore nel Fediverso \ No newline at end of file +Plugin WordPress per mostrare un box che permette agli utenti di seguire l'autore nel Fediverso. + +## Caratteristiche + +- ✅ Form per inserire istanza Mastodon +- ✅ Link diretto a fediverso.info per info +- ✅ Link per creare account su mastodon.uno +- ✅ Validazione input +- ✅ Responsive design +- ✅ Debug mode attivabile + +## Installazione + +1. Carica la cartella `fediverso-box` in `/wp-content/plugins/` +2. Attiva il plugin dal pannello WordPress + +## Utilizzo + +### Via PHP +```php + +``` + +### Via Shortcode +``` +[fediverso_box] +``` + +## Configurazione + +Modifica l'handle dell'autore in `fediverso-box.php`: +```php +$author_handle = 'tuoaccount@tuaistanza.it'; +``` + +## Debug + +Per attivare i log in console: +```php +define('FEDIVERSO_BOX_DEBUG', true); +``` + +## Versione + +v2.1 (Production) + +## Autore + +Emanuele Gori - https://emanuelegori.uno \ No newline at end of file