diff --git a/README.md b/README.md index c322716..b078d22 100644 --- a/README.md +++ b/README.md @@ -31,3 +31,77 @@ user and no rights for the group. All files should have `chmod 400`. The script has the specialty that sends an email when something goes wrong, so I am notifed and can fix the issue. If you don't want that, simply open `mail/mail.py` and replace everyting in the init function with a simple `pass`. + +## How does it integrate into Hugo? + +It puts the full json reply from twitter into the data directory, if correctly configured. From there you can do two +things: + +* Automate the build (strongly recommended) +* Build a template that uses the json data to build a twitter card. + +I build the template using a [partial template](https://gohugo.io/templates/partials/#readout). It sits in the directory +`layouts/partials` and is called `latest_tweet.html`. The content is not very interesting: + +``` +
+ {{ .full_text | safeHTML }} +
+