Merge pull request #6 from mitodl/wassaf/add-documentaion

updated read me  and resolved dependency conflict

README.rst

@@ -86,6 +86,30 @@ Build a production distribution::
 
   npm run build
 
+***********
+Local Development
+***********
+
+For local development and testing follow these steps. (for convenince sake consider learning MFE as parent app)
+
+* Clone frontend-component-footer-mitol into frontend-app-learning directory.
+* CD into the frontend-component-footer-mitol and run the following commands::
+    
+    npm i
+
+    npm build
+* Verify a `dist/` forlder has been created.
+* CD back into frontend-app-learning and create a module.config.js file
+* Place the following code inf the module.config.js::
+    
+    localModules: [
+       { moduleName: '@edx/frontend-component-footer', dir: './frontend-component-footer-mitol' },
+       }
+    }
+
+* Restart frontend-app-learning and verify it is using the local version  from @edx/frontend-component-footer
+* For css changes you might need to rebuild again.
+
 .. |Build Status| image:: https://api.travis-ci.com/edx/frontend-component-footer.svg?branch=master
    :target: https://travis-ci.com/edx/frontend-component-footer
 .. |Codecov| image:: https://img.shields.io/codecov/c/github/edx/frontend-component-footer

package.json

@@ -12,8 +12,7 @@
     "lint": "fedx-scripts eslint --ext .js --ext .jsx .",
     "snapshot": "fedx-scripts jest --updateSnapshot",
     "start": "fedx-scripts webpack-dev-server --progress",
-    "test": "fedx-scripts jest --coverage",
-    "prepare": "npm run build"
+    "test": "fedx-scripts jest --coverage"
   },
   "files": [
     "/dist"
@@ -59,9 +58,9 @@
     "@fortawesome/react-fontawesome": "0.1.16"
   },
   "peerDependencies": {
-    "@edx/frontend-platform": "^1.8.0",
+    "@edx/frontend-platform": "^1.12.7",
     "prop-types": "^15.5.10",
-    "react": "^16.9.0",
-    "react-dom": "^16.9.0"
+    "react": "^17.0.2",
+    "react-dom": "^17.0.2"
   }
 }