README.md in cistern-2.0.2 vs README.md in cistern-2.0.3
- old
+ new
@@ -9,13 +9,13 @@
## Usage
### Service
-This represents the remote service that you are wrapping. If the service name is 'foo' then a good name is 'Foo::Client'.
+This represents the remote service that you are wrapping. If the service name is `foo` then a good name is `Foo::Client`.
-Service initialization parameters are enumerated by `requires` and `recognizes`. `recognizes` parameters are optional.
+Service initialization parameters are enumerated by `requires` and `recognizes`. Parameters defined using `recognizes` are optional.
```ruby
class Foo::Client < Cistern::Service
requires :hmac_id, :hmac_secret
recognizes :url
@@ -32,11 +32,11 @@
Cistern will define for you two classes, `Mock` and `Real`.
### Mocking
-Cistern strongly encourages you to generate mock support for service. Mocking can be enabled using `mock!`.
+Cistern strongly encourages you to generate mock support for your service. Mocking can be enabled using `mock!`.
```ruby
Foo::Client.mocking? # falsey
real = Foo::Client.new # Foo::Client::Real
Foo::Client.mock!
@@ -68,11 +68,11 @@
end
Foo::Client.new.get_bar # "i'm real"
```
-The `#service_method` function allows you to specific the name of generated method.
+The `#service_method` function allows you to specify the name of the generated method.
```ruby
class Foo::Client::GetBars < Foo::Client::Request
service_method :get_all_the_bars
@@ -222,11 +222,10 @@
```ruby
client.data["bars"] += ["y"] # ["y"]
client.data.object_id # 70199868378300
client.clear
client.data["bars"] # []
-
-client.data.object_id # 70199868566840
+client.data.object_id # 70199868378300
```
* `store` and `[]=` write
* `fetch` and `[]` read