Read.me update

README.md

@@ -1,94 +1,56 @@
 # 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.
+This is Belén Pruvost's assessment project for the React Fundamentals module, included in Udacity's React Fundamentals course. 
 
-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.
+It is a bookshelf app that allows you to select and categorize books you have read, are currently reading, or want to read. 
+Information is persisted through an API as you interact with the application.
 
-## TL;DR
+## Running the app locally
+* install all project dependencies with `npm install`
+* start the development server with `npm start`
 
-To get started developing right away:
+## Sections
 
-- install all project dependencies with `npm install`
-- start the development server with `npm start`
+### My Library
+This section shows the three shelves available:
+- Currently reading
+- Want to Read
+- Read
 
-## What You're Getting
+Each shelf shows the set of books that the user has denoted as currently reading, wanted to read and read, respectively.
 
-```bash
-├── CONTRIBUTING.md
-├── README.md - This file.
-├── SEARCH_TERMS.md # The whitelisted short collection of available search terms for you to use with your app.
-├── package.json # npm package manager file. It's unlikely that you'll need to modify this.
-├── public
-│   ├── favicon.ico # React Icon, You may change if you wish.
-│   └── 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.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.
-    │   ├── add.svg
-    │   ├── arrow-back.svg
-    │   └── 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.
-```
+![my library](images/my-library.png)
 
-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.
+Each book shows its title, its authors and its cover. If there is no specific cover specified on the API, a default cover image will be displayed instead.
+Moreover, each book has a control that allows you to move them to a different shelf, or out of the library.
 
-## Backend Server
+![book](images/book-control.png)
 
-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:
+When a movement operation is done, a success modal will be displayed, and the book will be moved accordingly.
 
-- [`getAll`](#getall)
-- [`update`](#update)
-- [`search`](#search)
+![modal](images/success-modal.png)
 
-### `getAll`
+When an async operation is done, a loader will be displayed.
 
-Method Signature:
+![loader](images/loader.png)
 
-```js
-getAll();
-```
+This section also provides access to the Search page.
 
-- Returns a Promise which resolves to a JSON object containing a collection of book objects.
-- This collection represents the books currently in the bookshelves in your app.
 
-### `update`
+### Search
+This section allows you to search for books. The list of available search terms that will actually return results is available [here](SEARCH_TERMS.md). 
 
-Method Signature:
+![search](images/search.png)
 
-```js
-update(book, shelf);
-```
+However, if no results are found - a message indicating so will be displayed.
 
-- book: `<Object>` containing at minimum an `id` attribute
-- shelf: `<String>` contains one of ["wantToRead", "currentlyReading", "read"]
-- Returns a Promise which resolves to a JSON object containing the response data of the POST request
+![no results](images/no-results.png)
 
-### `search`
+Also - if there is any issue connecting to the API, an error image will be displayed.
 
-Method Signature:
+![error](images/error.png)
 
-```js
-search(query);
-```
 
-- query: `<String>`
-- Returns a Promise which resolves to a JSON object containing a collection of a maximum of 20 book objects.
-- These books do not know which shelf they are on. They are raw results only. You'll need to make sure that books have the correct state while on the search page.
+When results are indeed found, books are displayed in the same way as in the Library section, indicating their title, their authors and their cover. A control is available to move them into or out of the shelves.
 
-## Important
-
-The backend API uses a fixed set of cached search results and is limited to a particular set of search terms, which can be found in [SEARCH_TERMS.md](SEARCH_TERMS.md). That list of terms are the _only_ terms that will work with the backend, so don't be surprised if your searches for Basket Weaving or Bubble Wrap don't come back with any results.
-
-## Create React App
-
-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).
-
-## Contributing
-
-This repository is the starter code for _all_ Udacity students. Therefore, we most likely will not accept pull requests.
-
-For details, check out [CONTRIBUTING.md](CONTRIBUTING.md).
+By clicking the back button (on the page or on the browser), it is possible to go back to the Library page.