docs: Update README.rst with notes about bind mounts (#147)

Adds notes about local bind mounts.
overhangio · Oct 6, 2023 · 455bd21 · 455bd21
1 parent b55bdc0
commit 455bd21
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/README.rst b/README.rst
@@ -150,7 +150,7 @@ To disable an existing MFE, remove the corresponding entry from the ``MFE_APPS``
     def _remove_some_my_mfe(mfes):
         mfes.pop("account")
         mfes.pop("profile")
-        ...
+        return mfes
 
 Adding custom translations to your MFEs
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -329,6 +329,8 @@ This works for custom MFEs, as well. For example, if you added your own MFE name
 
 Similarly, in production, the "mfe" Docker image will be rebuilt automatically during ``tutor local launch``.
 
+Note: the name of the bind-mount folder needs to match the name of the repository word-for-word. If you've forked an MFE repository with a custom name, be sure to change the name back to ensure the bind-mount works properly.
+
 Uninstall
 ---------