Skip to content
This repository was archived by the owner on Dec 4, 2023. It is now read-only.

Commit 4dbfbc3

Browse files
author
Sonya Green
committed
Capitalization polish
Making consistent use of "Ruby" and "Javascript" across the doc.
1 parent 8513e05 commit 4dbfbc3

1 file changed

Lines changed: 15 additions & 15 deletions

File tree

README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -7,27 +7,27 @@
77

88
## DESCRIPTION
99

10-
Embed the V8 Javascript interpreter into Ruby.
10+
Embed the V8 JavaScript interpreter into Ruby.
1111

1212

1313
## FEATURES
1414

15-
* Evaluate Javascript from within Ruby
16-
* Embed your Ruby objects into the Javascript world
15+
* Evaluate JavaScript from within Ruby
16+
* Embed your Ruby objects into the JavaScript world
1717
* Manipulate JavaScript objects and call JavaScript functions from Ruby
1818
* API compatible with the The Ruby Rhino (for JRuby: http://github.com/cowboyd/therubyrhino)
1919

2020
## SYNOPSIS
2121

2222
gem install therubyracer
2323

24-
then in your ruby code
24+
then in your Ruby code
2525

2626
require 'v8'
2727
# or if using bundler (as with Rails), add the following to your Gemfile
2828
gem "therubyracer", :require => 'v8'
2929

30-
evaluate some simple javascript
30+
evaluate some simple JavaScript
3131

3232
cxt = V8::Context.new
3333
cxt.eval('7 * 6') #=> 42
@@ -37,12 +37,12 @@ embed values into the scope of your context
3737
cxt['foo'] = "bar"
3838
cxt.eval('foo') # => "bar"
3939

40-
embed ruby code into your scope and call it from javascript
40+
embed Ruby code into your scope and call it from JavaScript
4141

4242
cxt["say"] = lambda {|this, word, times| word * times}
4343
cxt.eval("say('Hello', 3)") #=> HelloHelloHello
4444

45-
embed a ruby object into your scope and access its properties/methods from javascript
45+
embed a Ruby object into your scope and access its properties/methods from JavaScript
4646

4747
class MyMath
4848
def plus(lhs, rhs)
@@ -53,7 +53,7 @@ embed a ruby object into your scope and access its properties/methods from javas
5353
cxt['math'] = MyMath.new
5454
cxt.eval("math.plus(20,22)") #=> 42
5555

56-
make a ruby object *be* your global javascript scope.
56+
make a Ruby object *be* your global JavaScript scope.
5757

5858
math = MyMath.new
5959
V8::Context.new(:with => math) do |cxt|
@@ -64,7 +64,7 @@ you can do the same thing with Object#eval_js
6464

6565
math.eval_js("plus(20,22)")
6666

67-
## Different ways of loading javascript source
67+
## Different ways of loading JavaScript source
6868

6969
In addition to just evaluating strings, you can also use streams such as files.
7070

@@ -81,11 +81,11 @@ or load it by filename
8181

8282
## Safe by default, dangerous by demand
8383

84-
The Ruby Racer is designed to let you evaluate javascript as safely as possible unless you tell it to do something more
85-
dangerous. The default context is a hermetically sealed javascript environment with only the standard javascript objects
86-
and functions. Nothing from the ruby world is accessible at all.
84+
The Ruby Racer is designed to let you evaluate JavaScript as safely as possible unless you tell it to do something more
85+
dangerous. The default context is a hermetically sealed JavaScript environment with only the standard JavaScript objects
86+
and functions. Nothing from the Ruby world is accessible at all.
8787

88-
For ruby objects that you explicitly embed into javascript, by default only the _public_ methods _below_ `Object` are
88+
For Ruby objects that you explicitly embed into JavaScript, by default only the _public_ methods _below_ `Object` are
8989
exposed by default. E.g.
9090

9191
class A
@@ -118,12 +118,12 @@ exposed by default. E.g.
118118
If needed, you can override the [Ruby Access](https://github.com/cowboyd/therubyracer/blob/master/lib/v8/access.rb)
119119
to allow whatever behavior you'd like
120120

121-
More documentation can be found on the [github wiki](https://github.com/cowboyd/therubyracer/wiki)
121+
More documentation can be found on the [GitHub wiki](https://github.com/cowboyd/therubyracer/wiki)
122122

123123
## PREREQUISITES
124124

125125
For platforms for which there is a binary version of therubyracer gem available, there are no
126-
dependencies other than ruby and rubygems.
126+
dependencies other than Ruby and rubygems.
127127

128128
If there is not a binary version for your system, then you will need to compile it from source.
129129
To do this, you must have v8 >= 3.11.8 installed somewhere on your system. There are several

0 commit comments

Comments
 (0)