From 033d9c78bc58e325d933471e43575b8bf93b4f94 Mon Sep 17 00:00:00 2001 From: Dave Shoreman Date: Fri, 12 Dec 2014 01:07:50 +0000 Subject: [PATCH] Add installation notes --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index 8a4371e..0f40312 100644 --- a/README.md +++ b/README.md @@ -19,3 +19,22 @@ Username and password for the backend are both `admin`. Not yet... Check out the demo, browse the source, and have a gander at the optional [theme](https://github.com/dshoreman/octoshop-theme) if you want to play about. + + +## Installation + +Installing Octoshop is fairly simple, despite not yet being available in the October CMS Plugin store. +All you need to do is clone this repository, fire off composer and run the migrations: + +``` +cd /path/to/october-cms +mkdir -p plugins/dshoreman +git clone https://github.com/dshoreman/oc-shop.git plugins/dshoreman/shop +cd plugins/dshoreman/shop; composer install; cd - +php artisan october:up +``` + +Once you've completed the terminal bits, all that's left is to setup your Stripe API keys +in the backend. You'll find them in the Shop section of the Settings page. + +If you'd like to get started by trying the theme too, clone it into themes/octoshop.