Skip to content

Commit

Permalink
Add descriptions in README and gemspec
Browse files Browse the repository at this point in the history
  • Loading branch information
thisismydesign committed Jun 17, 2017
1 parent ecda436 commit 26f9c87
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 4 deletions.
15 changes: 13 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Encapsulators

WIP
#### Collection of practical functions to be used with the 'encapsulate' gem.

| Branch | Status |
| ------ | ------ |
Expand All @@ -25,7 +25,18 @@ Or install it yourself as:

## Usage

TODO: Write usage instructions here
See the [encapsulate](https://github.com/thisismydesign/encapsulate) gem.

```ruby
require 'encapsulate'
require 'encapsulators'

def base_function
# ...
end

Encapsulate.run callback: base_function, with: [Encapsulators.user_interaction_before_return, Encapsulators.exception_handling]
```

## Feedback

Expand Down
4 changes: 2 additions & 2 deletions encapsulators.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ Gem::Specification.new do |spec|
spec.authors = ["thisismydesign"]
spec.email = ["thisismydesign@users.noreply.github.com"]

spec.summary = ""
spec.homepage = ""
spec.summary = "Collection of practical functions to be used with the 'encapsulate' gem."
spec.homepage = "https://github.com/thisismydesign/encapsulators"

spec.files = `git ls-files -z`.split("\x0").reject do |f|
f.match(%r{^(test|spec|features)/})
Expand Down

0 comments on commit 26f9c87

Please sign in to comment.