From 0e37bdafb73263add7a7b68cbd1a64034d0deb9c Mon Sep 17 00:00:00 2001 From: Hrishi Mittal Date: Fri, 18 Aug 2017 22:47:29 +0100 Subject: [PATCH] Update README --- README.md | 25 ++++--------------------- 1 file changed, 4 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 7db80e4..c4ad98d 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,7 @@ -# README +# Idea Board API -This README would normally document whatever steps are necessary to get the -application up and running. +An Idea board app built as a Rails 5.1 API app, based on the [Rails 5 API and React.js tutorial - How to make an Idea board app](https://learnetto.com/tutorials/rails-5-api-and-react-js-tutorial-how-to-make-an-idea-board-app). -Things you may want to cover: +The app has API endpoints for adding, editing and deleting ideas. -* Ruby version - -* System dependencies - -* Configuration - -* Database creation - -* Database initialization - -* How to run the test suite - -* Services (job queues, cache servers, search engines, etc.) - -* Deployment instructions - -* ... +See this [React frontend app code](https://github.com/learnetto/ideaboard) to talk to this API.