Pull Request from Dev to Master

README.md

@@ -1,43 +1,8 @@
-# MyReads Project
+# my-reads.github.io
 
-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.
+My reads is one of the last projects developed during the Advanced Nanodegree Front-End Web Developer course, and was created to implement a personal shelf which allows users to manupulate books they are reading, books they want to read and books they've already read. This project was build through React and uses the purest concept of ES6.
 
-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.
-
-## TL;DR
-
-To get started developing right away:
-
-* install all project dependencies with `npm install`
-* start the development server with `npm start`
-
-## What You're Getting
-```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.
-```
-
-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:
+It is important to mention this project uses an API provided and described by Udacity. The provided file [`BooksAPI.js`](src/BooksAPI.js) contains the methods you will need to perform necessary operations on the backend:
 
 * [`getAll`](#getall)
 * [`update`](#update)
@@ -51,8 +16,7 @@ Method Signature:
 getAll()
 ```
 
-* 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.
+* getAll() is responsible to return a promise with a collection of books (the ones which are supposed to be in the bookshelf)
 
 ### `update`
 
@@ -62,9 +26,9 @@ Method Signature:
 update(book, shelf)
 ```
 
-* 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
+* book: `<Object>` this is the object which should contain an id related to the book itself
+* shelf: `<String>` this is a string which represents the position of this book in the shelf, in other words, want to read, currently reading or read
+* Returns a Promise with a list of id's related to the books and also returns the shelf position each book is
 
 ### `search`
 
@@ -75,18 +39,55 @@ 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.
+* Returns a Promise with a collection of books
 
 ## 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.
+This backend provided by Alura does its search in a limited amount of books, so do not hesitate if you don't get an expected book.
+
+## How to use
 
-## Create React App
+Download the project directly or go to a specific folder and download it by git:
 
-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).
+* `git init` 
 
-## Contributing
+* `git clone https://github.com/pedroarvellos/`
 
-This repository is the starter code for _all_ Udacity students. Therefore, we most likely will not accept pull requests.
+* install all project dependencies with `npm install`
+* start the development server with `npm start`
+
+## What You're Getting
+```bash
+├── CONTRIBUTING.md
+├── README.md - This file.
+├── SEARCH_TERMS.md 
+├── package.json 
+├── public
+│   ├── favicon.ico 
+│   └── index.html
+└── src
+    ├── css 
+    │   ├── App.css
+    │   ├── index.css 
+    ├── icons 
+    │   ├── add.svg
+    │   ├── arrow-back.svg
+    │   └── arrow-drop-down.svg
+    ├── js
+    │   ├── book
+    │   │   ├── Book.js
+    │   │   ├── BookStatus.js
+    │   ├── book-shelf
+    │   │   ├── BookShelf.js
+    │   │   
+    │   ├── search
+    │   │   ├── Search.js
+    │   │   
+    │   ├── service
+    │   │   ├── BooksAPI.js
+    │   │   
+    ├── App.js
+    ├── App.test.js 
+    └── index.js 
+
+The project can be opened in any text editor, for example: _Sublime Text_, _Visual Studio_,  _Atom_, etc. To execute the project.
 
-For details, check out [CONTRIBUTING.md](CONTRIBUTING.md).