Merge pull request #7 from edx/robrap/update-readme

Update README.rst
fix(docs): update README.rst
2019-03-08 09:44:26 -05:00 · 2019-03-06 09:36:43 -05:00
1 changed files with 3 additions and 0 deletions
--- a/README.rst
+++ b/README.rst
@@ -7,6 +7,9 @@ frontend-component-footer
 frontend-component-footer is a library containing a site footer
 component for use when building edX frontend applications.

+At this time, this componenet is hard-coded to match the legacy LMS site footer, including all of its links.
+Note: As implemented, it should really be called the ``frontend-component-lms-footer``.
+
 Usage
 -----
Author	SHA1	Message	Date
Robert Raposa	7f2c5b32b1	Merge pull request #7 from edx/robrap/update-readme Update README.rst	2019-03-08 09:44:26 -05:00
Robert Raposa	6e0f9cf30a	fix(docs): update README.rst Add a note to clarify that this component is not really a flexible site footer at this time.	2019-03-06 09:36:43 -05:00