docs: update readme to reflect recent subscription changes (#312)

openedx · Jul 13, 2023 · ffdebc3 · ffdebc3
1 parent f6f5717
commit ffdebc3
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 1 deletion.
diff --git a/README.rst b/README.rst
@@ -8,7 +8,7 @@ Please tag **@edx/revenue-squad** on any PRs or issues.
 Introduction
 ------------
 
-This is a micro-frontend application responsible for the display of an authenticated user's order history and receipt page.
+This is a micro-frontend application responsible for the display of an authenticated user's single purchase order history and subscription history. Additional work has been done and is in-progress to enable receipt pages in this application, currently hosted in ecommerce.
 
 Installation
 ------------
@@ -34,6 +34,10 @@ This MFE is bundled with `Devstack <https://github.com/openedx/devstack>`_, see
 
    .. image:: ./docs/images/localhost_preview.png
 
+   Note: the alert will always display if subscriptions repo is not setup locally
+
+6. **(Optional)** For edx developers, they can set up the subscriptions repo for viewing subscription history
+
 Environment Variables/Setup Notes
 ---------------------------------
 

diff --git a/docs/images/localhost_preview-old.png b/docs/images/localhost_preview-old.png
diff --git a/docs/images/localhost_preview.png b/docs/images/localhost_preview.png