Skip to content

feat: update README file for gamexblock - #28

Merged
djoseph-apphelix merged 1 commit into
mainfrom
feat/README
Mar 6, 2026
Merged

djoseph-apphelix merged 1 commit into
mainfrom
feat/README

Conversation

@viv-helix

@viv-helix viv-helix commented Mar 6, 2026 •

Copy link
Copy Markdown
Contributor

Description

This PR updates the README.md for the edx-games XBlock to improve clarity and documentation quality.

Changes

  • Added a clear overview of the Games XBlock and supported game types.
  • Documented features including image support, shuffling, timer, pagination, confetti animation, and encrypted answer keys.
  • Added requirements and dependency versions.
  • Included installation instructions via pip.
  • Added step-by-step usage instructions for enabling the XBlock in Studio.
  • Documented configuration options, including: Waffle flag setup, Custom storage backend (filesystem and S3 examples)
  • Added a security section describing answer-key encryption, JS obfuscation, and upload validation.

Overall, this improves developer and platform operator guidance for installing and configuring the edx-games XBlock.

Jira

@djoseph-apphelix
djoseph-apphelix merged commit 802416a into main Mar 6, 2026
2 of 4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants