Skip to content

Commit dff179f

Browse files
eliameh
authored andcommittedFeb 17, 2015
README: add a usage section
Give the number of people mis-requiring the library client side seems a good idea to make it a bit more clear.
1 parent 20d8806 commit dff179f

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed
 

Diff for: ‎README.md

+20
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,26 @@ Browser support for Opal
99
This library aims to be a full-blown wrapper for all the browser API including
1010
HTML5.
1111

12+
Usage
13+
=====
14+
15+
_Server side (config.ru, Rakefile, Rails, Sinatra, etc.)_
16+
17+
```ruby
18+
require 'opal-browser'
19+
# Your server code here
20+
```
21+
22+
_Browser side_
23+
24+
```ruby
25+
require 'opal'
26+
require 'browser'
27+
# Your Opal code here
28+
```
29+
30+
31+
1232
Features
1333
========
1434
This is a list of the currently wrapped features and some details on them.

0 commit comments

Comments
 (0)
Please sign in to comment.