project.readme -> project.instructions

Author: inlinestyle

src/clients/github.js

@@ -108,9 +108,9 @@ function buildGistFromProject(project) {
       language: 'JavaScript',
     };
   }
-  if (trim(project.readme)) {
+  if (trim(project.instructions)) {
     files['README.md'] = {
-      content: project.readme,
+      content: project.instructions,
       language: 'Markdown',
     };
   }

src/components/Dashboard.jsx

@@ -77,7 +77,7 @@ class Dashboard extends React.Component {
   }
 
   render() {
-    const {readme, isOpen} = this.props;
+    const {instructions, isOpen} = this.props;
     if (!isOpen) {
       return null;
     }
@@ -92,8 +92,8 @@ class Dashboard extends React.Component {
     return (
       <div className={sidebarClassnames}>
         {this._renderMenu()}
-        <div className="dashboard__readme">
-          {remark().use(remarkReact).processSync(readme).contents}
+        <div className="dashboard__instructions">
+          {remark().use(remarkReact).processSync(instructions).contents}
         </div>
         <div className="dashboard__spacer" />
         {this._renderLinks()}
@@ -105,9 +105,9 @@ class Dashboard extends React.Component {
 Dashboard.propTypes = {
   currentUser: PropTypes.object.isRequired,
   gistExportInProgress: PropTypes.bool.isRequired,
+  instructions: PropTypes.string.isRequired,
   isExperimental: PropTypes.bool.isRequired,
   isOpen: PropTypes.bool.isRequired,
-  readme: PropTypes.string.isRequired,
   onExportGist: PropTypes.func.isRequired,
   onExportRepo: PropTypes.func.isRequired,
 };

src/containers/Dashboard.js

@@ -17,9 +17,9 @@ function mapStateToProps(state) {
   return {
     currentUser: getCurrentUser(state),
     gistExportInProgress: isGistExportInProgress(state),
+    instructions: project ? project.instructions : '',
     isExperimental: isExperimental(state),
     isOpen: isDashboardOpen(state),
-    readme: project ? project.readme : '',
   };
 }
 

src/css/application.css

@@ -370,7 +370,7 @@ body {
   font-weight: bold;
 }
 
-.dashboard__readme {
+.dashboard__instructions {
   overflow: scroll;
 }
 

src/records/Project.js

@@ -14,23 +14,23 @@ export default class Project extends Record({
   enabledLibraries: new Set(),
   hiddenUIComponents: new Set(),
   updatedAt: null,
-  readme: '',
+  instructions: '',
 }) {
   static fromJS({
     projectKey = null,
     sources = {},
     enabledLibraries = [],
     hiddenUIComponents = [],
     updatedAt = null,
-    readme = '',
+    instructions = '',
   }) {
     return new Project({
       projectKey,
       sources: new Sources(sources),
       enabledLibraries: new Set(enabledLibraries),
       hiddenUIComponents: new Set(hiddenUIComponents),
       updatedAt,
-      readme,
+      instructions,
     });
   }
 }

src/reducers/projects.js

@@ -32,7 +32,8 @@ function unhideComponent(state, projectKey, component, timestamp) {
 function contentForLanguage(files, language) {
   const filesForLanguage = sortBy(
     filter(files, {language}),
-    file => file.filename);
+    file => file.filename,
+  );
   return map(filesForLanguage, 'content').join('\n\n');
 }
 
@@ -52,7 +53,7 @@ function importGist(state, projectKey, gistData) {
       },
       enabledLibraries: popcodeJson.enabledLibraries || [],
       hiddenUIComponents: popcodeJson.hiddenUIComponents || [],
-      readme: contentForLanguage(files, 'Markdown'),
+      instructions: contentForLanguage(files, 'Markdown'),
     },
   );
 }