chore: add readme

Author: denisebroekman

README.md

@@ -1,59 +1,62 @@
-# QtiEditorAngular
 
-This project was generated using [Angular CLI](https://github.com/angular/angular-cli) version 21.2.6.
+# QTI Editor Angular Extension
 
-## Development server
+This project is an example Angular integration of the [qti-editor](https://github.com/Citolab/qti-editor) ecosystem. It demonstrates how to integrate QTI Editor’s modular, ProseMirror-based authoring environment into an Angular application, using the recommended public packages and UI registry approach.
 
-To start a local development server, run:
+**Live Demo:** [https://citolab.github.io/qti-editor-angular/](https://citolab.github.io/qti-editor-angular/)
 
-```bash
-ng serve
-```
+---
 
-Once the server is running, open your browser and navigate to `http://localhost:4200/`. The application will automatically reload whenever you modify any of the source files.
+## About
 
-## Code scaffolding
+This application is designed to showcase and extend the capabilities of the main [qti-editor](https://github.com/Citolab/qti-editor) repository. It provides a reference implementation for embedding QTI-compliant authoring tools in Angular apps, following the best practices outlined in the [qti-editor documentation](https://qti-editor.citolab.nl/docs).
 
-Angular CLI includes powerful code scaffolding tools. To generate a new component, run:
+The editor is built on [ProseMirror](https://prosemirror.net/) and leverages QTI-specific schema nodes, commands, and web components. This ensures that authored content is always valid QTI and that only supported interactions and structures are allowed.
 
-```bash
-ng generate component component-name
-```
+## Integration Approach
 
-For a complete list of available schematics (such as `components`, `directives`, or `pipes`), run:
+- Install the required `@qti-editor` interaction and core packages from npm.
+- Use [ProseKit](https://prosekit.dev) for ready-made UI components, or copy example Lit UI components from the registry.
+- Maintain a small local ProseKit helper layer for editor assembly and event wiring.
+- The intended public model is: `prosekit` + `@qti-editor/interaction-*` + `@qti-editor/core` + copied registry UI.
 
-```bash
-ng generate --help
-```
+For more details, see the [Angular integration guide](https://qti-editor.citolab.nl/docs/frameworks/angular/).
 
-## Building
+## Development
 
-To build the project run:
+To start a local development server:
 
 ```bash
-ng build
+ng serve
 ```
 
-This will compile your project and store the build artifacts in the `dist/` directory. By default, the production build optimizes your application for performance and speed.
+Visit `http://localhost:4200/` in your browser. The app will reload automatically on code changes.
 
-## Running unit tests
+## Building
 
-To execute unit tests with the [Vitest](https://vitest.dev/) test runner, use the following command:
+To build the project for production:
 
 ```bash
-ng test
+ng build --configuration production --base-href /qti-editor-angular/
 ```
 
-## Running end-to-end tests
+The build output will be in the `dist/` directory. This project is automatically deployed to GitHub Pages on every push to `main`.
 
-For end-to-end (e2e) testing, run:
+## Testing
+
+To run unit tests:
 
 ```bash
-ng e2e
+ng test
 ```
 
-Angular CLI does not come with an end-to-end testing framework by default. You can choose one that suits your needs.
+## Resources
+
+- [QTI Editor Documentation](https://citolab.github.io/qti-editor/)
+- [QTI Editor Angular Integration Guide](https://citolab.github.io/qti-editor/docs/frameworks/angular/)
+- [Main qti-editor repository](https://github.com/Citolab/qti-editor)
+- [ProseKit](https://prosekit.dev)
 
-## Additional Resources
+---
 
-For more information on using the Angular CLI, including detailed command references, visit the [Angular CLI Overview and Command Reference](https://angular.dev/tools/cli) page.
+For questions or contributions, please see the main [qti-editor](https://github.com/Citolab/qti-editor) repository.