README.md in acfs-0.6.0 vs README.md in acfs-0.7.0
- old
+ new
@@ -8,11 +8,11 @@
## Installation
Add this line to your application's Gemfile:
- gem 'acfs', '0.6.0'
+ gem 'acfs', '0.7.0'
**Note:** Acfs is under development. I'll try to avoid changes to the public
API but internal APIs may change quite often.
And then execute:
@@ -28,10 +28,16 @@
First you need to define your service(s):
```ruby
class UserService < Acfs::Service
self.base_url = 'http://users.myapp.org'
+
+ # You can configure middlewares you want use for the service here.
+ # Each service has it own middleware stack.
+ #
+ use Acfs::Middleware::JsonDecoder
+ use Acfs::Middleware::MessagePackDecoder
end
```
This specifies where the `UserService` can be reached. You can now create some
models representing resources serviced by the `UserService`.
@@ -112,27 +118,28 @@
# Now we can access all resources:
@user.name # => "John
@comments.size # => 25
@friends[0].name # => "Miraculix"
+```
## TODO
* Create/Update operations
* High level features
-** Pagination? Filtering? (If service API provides such features.)
-** Messaging Queue support for services and models
+ * Pagination? Filtering? (If service API provides such features.)
+ * Messaging Queue support for services and models
* Documentation
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
-3a. Add specs for your feature
-3b. Implement your feature
-3c. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+4. Add specs for your feature
+5. Implement your feature
+6. Commit your changes (`git commit -am 'Add some feature'`)
+7. Push to the branch (`git push origin my-new-feature`)
+8. Create new Pull Request
## License
MIT License