README.md in doppelserver-0.2.8 vs README.md in doppelserver-0.4.9
- old
+ new
@@ -1,9 +1,10 @@
# Doppelserver
[![TravisCI](https://api.travis-ci.org/drewcoo/doppelserver.svg)](https://travis-ci.org/drewcoo/doppelserver)
[![CircleCI](https://circleci.com/gh/drewcoo/doppelserver.svg?style=shield)](https://circleci.com/gh/drewcoo/doppelserver)
+[![AppVeyor](https://ci.appveyor.com/api/projects/status/ho7j5joad8hk867s?svg=true)](https://ci.appveyor.com/project/drewcoo/doppelserver)
[![Coverage Status](https://coveralls.io/repos/github/drewcoo/doppelserver/badge.svg?branch=master)](https://coveralls.io/github/drewcoo/doppelserver?branch=master)
[![Gem Version](https://badge.fury.io/rb/doppelserver.svg)](https://badge.fury.io/rb/doppelserver)
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/dd50d7ee18ae46c38ad053cf3dc59794)](https://www.codacy.com/app/drewcoo/doppelserver?utm_source=github.com&utm_medium=referral&utm_content=drewcoo/doppelserver&utm_campaign=Badge_Grade)
Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/doppelserver`. To experiment with that code, run `bin/console` for an interactive prompt.
@@ -14,21 +15,15 @@
TODO: Explain mocks, dups, and fakes. This is a fake. Explain why fakes.
Also, all the cool names were taken on RubyGems.
-### Alternatives
-
-TODO: Table of alternatives.
-
## Installation
Add this line to your application's Gemfile:
- ```ruby
gem 'doppelserver'
- ```
And then execute:
$ bundle
@@ -52,15 +47,26 @@
* REST-ish
* GraphQL
* Others? (WSDL?)
* Client bindings? Not sure that makes sense unless it's POROs or x-language.
-
## Development
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bundle` to install dependencies. Then, run `bundle exec rake` to run the tests.
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run
+
+ bundle exec rake install
+
+To release a new version, update the version number in `version.rb` like so
+
+ bundle exec gem bump -v [major|minor|patch|pre|release]
+
+and then run
+
+ bundle exec rake release
+
+which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/drewcoo/doppelserver.