diff --git a/README.md b/README.md index e1203dc..265abb4 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # Click-to-reveal-XBlock -A basic, slightly wonky XBlock to reveal some text when a button element is clicked. +A basic XBlock to reveal some HTML when a button element is clicked. An Open edX 2016 Hackathon project. -Four fields: +Available fields: - 'Show' action name (such as 'Reveal', 'Click to' or 'Show') - 'Hide' action name (such as 'Close', 'Click to' or 'Hide') - Text Label (such as 'Comment', 'Description' or 'Text') - This displays both on the button and as a heading in the text @@ -10,3 +10,12 @@ Four fields: This is to try and make the way the button displays as customisable as possible. It defaults to 'Reveal Comment' and 'Hide Comment'. Contains ARIA tags in an attempt at making the functionality accessible to screen readers. + +# Screenshots +## Studio +![Studio view](http://i.imgur.com/C3wyytq.png) +![Studio view](http://i.imgur.com/M9rxdIp.png) + +## LMS +![LMS view](http://i.imgur.com/9xcG5pX.png) +![LMS view](http://i.imgur.com/FWEiDDb.png)