Merge pull request #2 from davidjoy/main

docs: adding a modest README

README.md

@@ -1,2 +1,35 @@
-# frontend-base
-[alpha] Implementation of OEP-65
+# Open edX frontend framework
+
+| :rotating_light: Pre-alpha                                                                |
+|:------------------------------------------------------------------------------------------|
+| frontend-base is under **active development** and may change significantly without warning. |
+
+This library is a **future** replacement for many of the foundational libraries in the Open edX frontend.
+
+Development of this library is part of a project to create a reference implementation for [OEP-65: Frontend Composability](https://open-edx-proposals.readthedocs.io/en/latest/architectural-decisions/oep-0065-arch-frontend-composability.html).
+
+It will replace:
+
+- https://github.com/openedx/frontend-build
+- https://github.com/openedx/frontend-platform
+- https://github.com/openedx/frontend-plugin-framework
+- https://github.com/openedx/frontend-component-header
+- https://github.com/openedx/frontend-component-footer
+
+The new frontend framework will completely take over responsibility for the functionality of those libraries, and will also include a "shell" application.
+
+It will enable Open edX frontends to be loaded as "module plugins" via Webpack module federation, or as "direct plugins" as part of a single, unified application.   It will also support creation of "project" repositories as a central place to check in an Open edX instance's frontend customizations and extensions.
+
+## Further reading
+
+- [OEP-65: Frontend composability](https://open-edx-proposals.readthedocs.io/en/latest/architectural-decisions/oep-0065-arch-frontend-composability.html)
+- [ADR 0001: Create a unified platform library](https://github.com/openedx/open-edx-proposals/pull/598)
+- [Discourse discussion on frontend projects](https://discuss.openedx.org/t/oep-65-adjacent-a-frontend-architecture-vision/13223)
+
+## Communication
+
+This project uses the [#module-federation](https://openedx.slack.com/archives/C06HRLTP3E0) channel in Open edX Slack.
+
+You can follow ongoing progress on the project's [Github project board](https://github.com/orgs/openedx/projects/65/views/1).
+
+Feel free to reach out to David Joy ([Github](https://github.com/davidjoy), [Slack](https://openedx.slack.com/team/UFM4FEN0J)) with any questions.