Skip to content
This repository
Browse code

Fix typos in Active Resource README

  • Loading branch information...
commit 87891de101ea02a8a342b4a66da9435aae010ed2 1 parent 76556b0
Jeffrey Hardy authored

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

  1. 14  activeresource/README
14  activeresource/README
... ...
@@ -1,7 +1,7 @@
1 1
 = Active Resource
2 2
 
3 3
 Active Resource (ARes) connects business objects and Representational State Transfer (REST)
4  
-web services.  It implements object-relational mapping for REST webservices to provide transparent 
  4
+web services.  It implements object-relational mapping for REST web services to provide transparent
5 5
 proxying capabilities between a client (ActiveResource) and a RESTful service (which is provided by Simply RESTful routing
6 6
 in ActionController::Resources).
7 7
 
@@ -22,14 +22,14 @@ received and serialized into a usable Ruby object.
22 22
 
23 23
 === Configuration and Usage
24 24
 
25  
-Putting ActiveResource to use is very similar to ActiveRecord.  It's as simple as creating a model class
  25
+Putting Active Resource to use is very similar to Active Record.  It's as simple as creating a model class
26 26
 that inherits from ActiveResource::Base and providing a <tt>site</tt> class variable to it:
27 27
 
28 28
    class Person < ActiveResource::Base
29 29
      self.site = "http://api.people.com:3000/"
30 30
    end
31 31
 
32  
-Now the Person class is REST enabled and can invoke REST services very similarly to how ActiveRecord invokes
  32
+Now the Person class is REST enabled and can invoke REST services very similarly to how Active Record invokes
33 33
 lifecycle methods that operate against a persistent store.
34 34
 
35 35
    # Find a person with id = 1
@@ -42,7 +42,7 @@ records.  But rather than dealing directly with a database record, you're dealin
42 42
 ==== Protocol
43 43
 
44 44
 Active Resource is built on a standard XML format for requesting and submitting resources over HTTP.  It mirrors the RESTful routing 
45  
-built into ActionController but will also work with any other REST service that properly implements the protocol. 
  45
+built into Action Controller but will also work with any other REST service that properly implements the protocol.
46 46
 REST uses HTTP, but unlike "typical" web applications, it makes use of all the verbs available in the HTTP specification:
47 47
 
48 48
 * GET requests are used for finding and retrieving resources.
@@ -55,8 +55,8 @@ for more general information on REST web services, see the article here[http://e
55 55
 
56 56
 ==== Find
57 57
 
58  
-GET Http requests expect the XML form of whatever resource/resources is/are being requested.  So,
59  
-for a request for a single element - the XML of that item is expected in response:
  58
+Find requests use the GET method and expect the XML form of whatever resource/resources is/are being requested.  So,
  59
+for a request for a single element, the XML of that item is expected in response:
60 60
 
61 61
    # Expects a response of
62 62
    #
@@ -101,7 +101,7 @@ Collections can also be requested in a similar fashion
101 101
 
102 102
 ==== Create
103 103
 
104  
-Creating a new resource submits the xml form of the resource as the body of the request and expects
  104
+Creating a new resource submits the XML form of the resource as the body of the request and expects
105 105
 a 'Location' header in the response with the RESTful URL location of the newly created resource.  The
106 106
 id of the newly created resource is parsed out of the Location response header and automatically set
107 107
 as the id of the ARes object.

0 notes on commit 87891de

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