Skip to content

Commit

Permalink
fix(docs): update README.rst
Browse files Browse the repository at this point in the history
Add a note to clarify that this component is not really
a flexible site footer at this time.
  • Loading branch information
robrap committed Mar 6, 2019
1 parent 3dc70a8 commit 6e0f9cf
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----

Expand Down

0 comments on commit 6e0f9cf

Please # to comment.