Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 55 lines (33 sloc) 1.385 kB
1267166 @malomalo Created RDoc task
malomalo authored
1 = \MLS - 42Floors Multiple Listing Service
2
3 MLS provides an Ruby interface for interacting with Commercial Real Estate
4 Listings provided by 42Floors.com.
5
6 *home* - https://mls.42floors.com
7
728107c @dana11235 Update README
dana11235 authored
8 *docs* - http://docs.42floors.com
1267166 @malomalo Created RDoc task
malomalo authored
9
10 *bugs* - https://github.com/42floors/mls/issues
11
12 == System Requirements
13
14 == Installation
15
16 $ gem install mls
17
18 == Configuration
19
20 The Gem needs to be configured with your API key and URL to connect to the
b35daaf @dana11235 Small tweaks to docs
dana11235 authored
21 42Floors MLS. For now, ask us to provide you with an API key.
1267166 @malomalo Created RDoc task
malomalo authored
22
23 #!ruby
24 require 'mls'
25
26 MLS.url = "https://{API_KEY}@mls.42floors.com"
27
28 You can also override the MLS asset host if you are connecting to the staging
29 environment and want the photos to load.
30
31 #!ruby
32 MLS.asset_host = "assets.42floors.com"
33
34 == Bugs
35
36 If you think you found a bug, file a ticket on the {issues
37 tracker}[https://github.com/42floors/mls/issues] on github.
38
39 To get your bug fixed as fast as possible please include a sample file that
40 illustrates the problem or link to a repository and include steps to reproduce
41 the issue. Here are some examples of good issues:
42
43 * https://github.com/rdoc/rdoc/issues/55
44 * https://github.com/rdoc/rdoc/issues/61
45
46 == License
47
48 #TODO
49
50 == Warranty
51
52 This software is provided "as is" and without any express or implied
53 warranties, including, without limitation, the implied warranties of
54 merchantability and fitness for a particular purpose.
Something went wrong with that request. Please try again.