simple README

okor преди 12 години
родител
ревизия
530a8f7ecd
променени са 1 файла, в които са добавени 47 реда и са изтрити 0 реда
  1. 47 0
      README.md

+ 47 - 0
README.md

@@ -1,4 +1,51 @@
1
+About WhoIz
2
+===========
1 3
 
4
+WhoIz is a simple WHOIS lookup application. It's built on Sinatra and Heroku friendly.
5
+
6
+
7
+Use It
2 8
 ======
3 9
 
10
+JSON
11
+
12
+    curl http://whoiz.herokuapp.com/lookup.json?url=yahoo.com
13
+
14
+Browser 
15
+    
16
+    http://whoiz.herokuapp.com
17
+    http://whoiz.herokuapp.com/lookup?url=yahoo.com
18
+
19
+
20
+Clone It
21
+========
22
+    git clone git://github.com/okor/whoiz.git
23
+
24
+
25
+Restrict It
26
+===========
27
+
28
+Edit
29
+
30
+    main.rb
31
+
32
+Change this
33
+
34
+    before do
35
+      response['Access-Control-Allow-Origin'] = '*'
36
+    end
37
+
38
+To this
39
+
40
+    before do
41
+      response['Access-Control-Allow-Origin'] = 'http://yourwebsite.com'
42
+    end
43
+
44
+
45
+Deploy It
46
+=========
47
+    heroku create
48
+    git push heroku master
49
+    heroku open
50
+
4 51