From 1aa99d56a94d4abe6b469217dc2c24527ab71529 Mon Sep 17 00:00:00 2001 From: ogom Date: Sat, 5 Dec 2015 23:50:22 +0900 Subject: [PATCH] Add README.md --- README.md | 26 ++++++++++++++++++++++++++ README.rdoc | 28 ---------------------------- 2 files changed, 26 insertions(+), 28 deletions(-) create mode 100644 README.md delete mode 100644 README.rdoc diff --git a/README.md b/README.md new file mode 100644 index 0000000..af03138 --- /dev/null +++ b/README.md @@ -0,0 +1,26 @@ +# Rails React Example + +* React with Redux on Rails +* Use [Redux and Redux-devtools CLI](https://github.com/banderson/generator-redux) + +## Installation + +``` +$ git clone https://github.com/dddrb/rails-react-example.git +$ cd rails-react-example/ +$ npm install +$ bundle install +$ foreman start +``` + +## Usage + +Click on the button of 'Update Title'. + +``` +$ open http://localhost:3000 +``` + +## License + +* MIT diff --git a/README.rdoc b/README.rdoc deleted file mode 100644 index dd4e97e..0000000 --- a/README.rdoc +++ /dev/null @@ -1,28 +0,0 @@ -== README - -This README would normally document whatever steps are necessary to get the -application up and running. - -Things you may want to cover: - -* 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 - -* ... - - -Please feel free to use a different markup language if you do not plan to run -rake doc:app.