diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 17 |
1 files changed, 6 insertions, 11 deletions
@@ -2,6 +2,8 @@ A script to load cards when you hover over a link in an article. +This is a fork of the [original project](https://github.com/capjamesg/hovercard.js) intended for use with [indieweb-glue](https://indieweb-glue.evgenykuznetsov.org/). + ## Example  @@ -20,17 +22,9 @@ To use the hovercard script, first download a copy and upload it to your site. T Substitute the path of the script in the example above with the location of the script on your site. -You should add a JSON object to every page that contains a hovercard. This JSON object should use the following structure: - - { - "https://example.com": { - "title": "Example Domain", - "description": "This domain is used for examples." - "photo": "https://example.com/example.png" - } - } +## Roadmap -Keys in the JSON object represent links on the page to look up. The only required key value is `title`. If a description and/or photo are provided, these will be included in the hovercard. +[ ] Customized hovercards for H-Cards. ## License @@ -38,4 +32,5 @@ This code for this project is placed in the public domain. ## Contributors -- capjamesg
\ No newline at end of file +- capjamesg +- evgenykuznetsov.org
\ No newline at end of file |