Skip to content
This repository
Browse code

Adds getting started instructions and contributors

  • Loading branch information...
commit f07f2d9010d5277eb5d7b221422b42bd03d1ea85 1 parent 12b5e74
M. Scott Ford authored February 08, 2013

Showing 1 changed file with 47 additions and 3 deletions. Show diff stats Hide diff stats

  1. 50  README.md
50  README.md
Source Rendered
... ...
@@ -1,8 +1,52 @@
1  
-spree_landlord
  1
+Landlord - Multi-tenant Spree extension
2 2
 ==============
3 3
 
4 4
 [![Build Status](https://travis-ci.org/railsdog/spree_landlord.png)](https://travis-ci.org/railsdog/spree_landlord)
5 5
 
6  
-Spree Multi-Tenancy
  6
+## What is Landlord?
  7
+
  8
+Landlord is a Spree extension that enables hosting multiple store fronts from a single Rails app.
  9
+
  10
+## Getting Started
  11
+
  12
+These instructions assume that you already have Spree installed in your Rails app.
  13
+
  14
+Add spree_landlord to your gemfile.
  15
+
  16
+```
  17
+gem 'spree_landlord', github: 'railsdog/spree_landlord'
  18
+```
  19
+
  20
+Run bundler.
  21
+
  22
+```
  23
+$ bundle install
  24
+```
  25
+
  26
+Install migrations.
  27
+
  28
+```
  29
+$ bundle exec rake spree_landlord:install:migrations
  30
+```
  31
+
  32
+Run migrations. This will create the first tenant, also known as the master tenant. It also moves your data into the tenant as well.
  33
+
  34
+```
  35
+$ bundle exec rake db:migrate
  36
+```
  37
+
  38
+Create a tenant. This will ask you for a `shortname`, and a `domain`. The `shortname` is used when accessing the tenant by subdomain such as `tenant-name.example.com`. The `domain` is used to access the tenant with just a domain name, such as `tenan.dev`. You'll also be asked if you want to populate the tenant with some sample products.
  39
+
  40
+```
  41
+$ bundle exec rake spree_landlord:tenant:create
  42
+```
  43
+
  44
+## Contributors
  45
+
  46
+* [John Dilts](https://github.com/jbrien)
  47
+* [M. Scott Ford](https://github.com/mscottford)
  48
+* [Jeff Squires](https://github.com/jsqu99)
  49
+* [Hector V.](https://github.com/hectorvs)
  50
+* [Javid Jamae](https://github.com/javidjamae)
  51
+
7 52
 
8  
-Just getting started here; nothing to see please move along.

0 notes on commit f07f2d9

Please sign in to comment.
Something went wrong with that request. Please try again.