diff --git a/README.md b/README.md index e93141e..d6f73dc 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,8 @@ ## About -This is a javascript widget that shows the public timeline of an account in the Federation (Diaspora, Friendica, Hubzilla) and Mastodon. Currently only tested with Friendica. - +This is a javascript widget that shows the public timeline of an account in the Federation (Diaspora, Friendica, Hubzilla) and Mastodon. Currently only tested with Friendica. The Federation widget parses the Atom output of your account. It shows the timeline from the personal or forum account on your personal blog or website. +It makes most sense for static website generators like Pelican. You only have to include the Javascript file, the CSS part and a placeholder in your website template. This works for a user or a group. It is loosely based on the [ELI widget](https://github.com/blankoworld/eli) for GNU Social.