From 03e0a2e2ec8ce48c9afa5ccab2bd9a3ec53d85d2 Mon Sep 17 00:00:00 2001 From: Mateusz Zdanowicz Date: Mon, 30 Oct 2017 22:06:54 +0100 Subject: [PATCH] Update README --- README.md | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 60f4e74..8b6aa7b 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,19 @@ This is a basic application to see book reviews, ratings and introduction. +## Requirements +* Ruby 2.2.2 or newer +* Rails 5.0.5 +* sqlite3 (included) + ## Running the app -1. Clone the app and run `bundle install` . -2. Run `rails s` to start server in development environment. +1. Clone the app and run `bin/setup` to install dependencies and create database. +2. Or `bundle install` and `bin/rails db:setup` to do it separately. +3. Run `rails s` to start server in development environment. + +## Features +* User sign up / log in +* View Books an their Reviews +* Filter Books by Category +* Create/Edit Books (category, title, description, author, cover - image attachment) +* Create/Edit Reviews for Books