Skip to content

Commit

Permalink
Merge pull request #46 from thommahoney/fix-docs
Browse files Browse the repository at this point in the history
minor docs cleanup
  • Loading branch information
lanej committed Jul 7, 2015
2 parents 0a42758 + daa85fb commit 5b37e21
Showing 1 changed file with 5 additions and 6 deletions.
11 changes: 5 additions & 6 deletions README.md
Expand Up @@ -11,9 +11,9 @@ Cistern helps you consistently build your API clients and faciliates building mo

### 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
Expand All @@ -34,7 +34,7 @@ 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
Expand Down Expand Up @@ -70,7 +70,7 @@ 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
Expand Down Expand Up @@ -224,8 +224,7 @@ 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
Expand Down

0 comments on commit 5b37e21

Please sign in to comment.