Testing enhancement

README.md

@@ -1,12 +1,13 @@
 # MyReads Project
 
-This is the starter template for the final assessment project for Udacity's React Fundamentals course. The goal of this template is to save you time by providing a static example of the CSS and HTML markup that may be used, but without any of the React code that is needed to complete the project. If you choose to start with this template, your job will be to add interactivity to the app by refactoring the static code in this template.
+The MyReads Project displays books. Each book can be assigned to one of three shelves -- currentlyReading, reading, read -- or none.
+The search page allows searching of books and assigning those books to a shelf.
 
-Of course, you are free to start this project from scratch if you wish! Just be sure to use [Create React App](https://github.com/facebookincubator/create-react-app) to bootstrap the project.
+Bootstrapped using [Create React App](https://github.com/facebookincubator/create-react-app) starting from the MyReads starter project.
 
 ## TL;DR
 
-To get started developing right away:
+To get started:
 
 * install all project dependencies with `npm install`
 * start the development server with `npm start`
@@ -22,7 +23,7 @@ To get started developing right away:
 │   └── index.html # DO NOT MODIFY
 └── src
     ├── App.css # Styles for your app. Feel free to customize this as you desire.
-    ├── App.js # This is the root of your app. Contains static HTML right now.
+    ├── App.js # App root.
     ├── App.test.js # Used for testing. Provided with Create React App. Testing is encouraged, but not required.
     ├── BooksAPI.js # A JavaScript API for the provided Udacity backend. Instructions for the methods are below.
     ├── icons # Helpful images for your app. Use at your discretion.
@@ -31,10 +32,16 @@ To get started developing right away:
     │   └── arrow-drop-down.svg
     ├── index.css # Global styles. You probably won't need to change anything here.
     └── index.js # You should not need to modify this file. It is used for DOM rendering only.
+    └── components
+        ├── Book.js #A single book; imports Cover.js and Menu.js
+        ├── Bookcase.js # Container for the shelves; imports Shelf.js
+        ├── Cover.js # Book image cover
+        ├── Menu.js # Menu item for moving books between shelves
+        ├── OpenSearch.js # Button on books page that navigates to search pagee
+        ├── Search.js # Search form and results that displays books; imports Book.js
+        └── Shelf.js # Displays books for each defined shelf; imports Book.js
 ```
 
-Remember that good React design practice is to create new JS files for each component and use import/require statements to include them where they are needed.
-
 ## Backend Server
 
 To simplify your development process, we've provided a backend server for you to develop against. The provided file [`BooksAPI.js`](src/BooksAPI.js) contains the methods you will need to perform necessary operations on the backend:
@@ -85,6 +92,10 @@ The backend API uses a fixed set of cached search results and is limited to a pa
 
 This project was bootstrapped with [Create React App](https://github.com/facebookincubator/create-react-app). You can find more information on how to perform common tasks [here](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md).
 
+## Testing
+This project is using Jest and Frisby to test the api call. Run the tests with the command:
+npm test
+
 ## Contributing
 
 This repository is the starter code for _all_ Udacity students. Therefore, we most likely will not accept pull requests.