Skip to content

Commit

Permalink
updating readme, changelog, and version; prepping for gem release
Browse files Browse the repository at this point in the history
  • Loading branch information
tomichj committed Jul 2, 2017
1 parent 2aa41f9 commit 5809480
Show file tree
Hide file tree
Showing 3 changed files with 54 additions and 4 deletions.
44 changes: 41 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,55 @@
# Invitation Changelog


## [0.4.2] - July 1, 2017

### API change
- accept a string for configuration.user_model and constantize it

[0.4.2]: https://github.com/tomichj/invitation/compare/0.4.1...0.4.2



## [0.4.1] - April 26, 2017

### Bugfix:
- added case_insensitive_email to template used by install generator

[0.4.1]: https://github.com/tomichj/invitation/compare/0.4...0.4.1



## [0.4] - April 26, 2017

### Feature:
- added case_sensitive_email configuration option.

[0.4]: https://github.com/tomichj/invitation/compare/0.3...0.4



## [0.3] - March 26, 2017

### Feature:
- Added support for Rails 5.1

[0.3]: https://github.com/tomichj/invitation/compare/0.2...0.3



## [0.2] - October 17, 2016

Contribution from [augustocbx](https://github.com/augustocbx) adding pt-BR locale file and fixing an init bug.
### Feature:
- adding pt-BR locale file and fixing an init bug.

[0.2]: https://github.com/tomichj/invitation/compare/0.1.1...0.2



## [0.1.1] - April 21, 2016

External APIs and usage remains the same, internal changes only:
* invites controller now users a Form object, form accepts :email or :emails, builds one invite per email address.
### Internal changes:
- invites controller now users a Form object, form accepts :email or :emails, builds one invite per email address.

[0.1.1]: https://github.com/tomichj/invitation/compare/0.1.0...0.1.1

Expand Down
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,17 @@ Please use [GitHub Issues] to report bugs. You can contact me directly on twitte
[![Gem Version](https://badge.fury.io/rb/invitation.svg)](https://badge.fury.io/rb/invitation) ![Build status](https://travis-ci.org/tomichj/invitation.svg?branch=master) ![Code Climate](https://codeclimate.com/github/tomichj/invitation/badges/gpa.svg)


### Warning - 0.4.2 api change

Release 0.4.2 includes an API change in configuration, config.user_model is now set to a string. Example:

```ruby
Invitation.configuration do |config|
config.user_model = 'Profile'
end
```


## Overview

Allow users to invite others to join an organization or resource. Plenty of gems can issue a 'system-wide' invitation,
Expand Down Expand Up @@ -352,6 +363,7 @@ Many thanks to:
* [augustocbx](https://github.com/augustocbx) added pt-BR locale file and fixed an init bug
* [vincentwoo](https://github.com/vincentwoo/) raising the security bar, & bumping Invitation to rails 5.1
* [conarro](https://github.com/conarro) added case_sensitive_email configuration option
* [itkin](https://github.com/itkin) bugfix, stringified configuration.user_model

## Future changes

Expand Down
2 changes: 1 addition & 1 deletion lib/invitation/version.rb
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
module Invitation
VERSION = '0.4.1'.freeze
VERSION = '0.4.2'.freeze
end

0 comments on commit 5809480

Please sign in to comment.