Skip to content

Commit

Permalink
Update CHANGELOG and README for v2 release
Browse files Browse the repository at this point in the history
- Add example to CHANGELOG
- Add note of breaking changes in v2 to README
  • Loading branch information
mtchavez committed May 26, 2017
1 parent ecdcb56 commit 28ad1a0
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 1 deletion.
23 changes: 22 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,29 @@
# Version 2.0.0 (Unreleased)

**Breaking Changes***
## Breaking Changes

* Remove all deprecated class methods in favor of instance API resources classes
* Please look at the documentation in the README or rubydoc on changes. An example of a change might be:

```ruby
#
# Old way of getting recent builds
#
builds = CircleCi::Project.recent_builds 'mtchavez', 'circleci'

#
# New way with a project object
#
project = CircleCi::Project.new 'mtchavez', 'circleci'
builds = project.recent_builds

# Can interact with other calls for the project
project.build # make a new build
project.settings # get settings
project.clear_cache #clear the cache
```



## Other changes

Expand Down
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,11 @@

Circle CI API Wrapper. Requires ruby `>= 2.0.0`.

**Version 2.x has breaking changes from v1.x**
> Please use branch v-1.1.0 or tag v1.1.0 for previous 1.x version of
> the gem until you can update to the latest version. 1.x will not be supported
> in the longer term.
## Install

```ruby
Expand Down

0 comments on commit 28ad1a0

Please sign in to comment.