From 799499c159b51e61ac9800e3b2a91569b4ceb057 Mon Sep 17 00:00:00 2001 From: Shishir Kakaraddi Date: Sat, 3 Feb 2018 10:36:18 -0800 Subject: [PATCH] updating documentation and travis --- .travis.yml | 2 +- README.md | 52 +++------------------------------------------------- 2 files changed, 4 insertions(+), 50 deletions(-) diff --git a/.travis.yml b/.travis.yml index 3971338..ca4855d 100644 --- a/.travis.yml +++ b/.travis.yml @@ -4,4 +4,4 @@ rvm: - 2.4.3 - 2.5.0 script: - - bundle exec rake spec + - bundle exec rspec diff --git a/README.md b/README.md index 914219a..bac08b4 100644 --- a/README.md +++ b/README.md @@ -177,61 +177,15 @@ serializer | Set custom Serializer for a relationship | ```has_many :actors, ser ## Contributing - -Please follow the steps on [contribution check](https://github.com/Netflix/fast_jsonapi/blob/master/CONTRIBUTING.md). -This gem is built using a gem building gem called [juwelier](https://github.com/flajann2/juwelier). - -Beyond just editing source code, you’ll be interacting with the gem using rake a lot. To see all the tasks available with a brief description, you can run: - -```bash -rake -T -``` - -### Updating Project information -You can update the project information of the gem by updating the [Rakefile](Rakefile). Then you need to generate a new gemspec: - -```bash -rake gemspec -``` +Please see [contribution check](https://github.com/Netflix/fast_jsonapi/blob/master/CONTRIBUTING.md) for more details on contributing ### Running Tests -We use [RSpec](http://rspec.info/) for testing. We have unit tests, functional tests and performance tests. To run tests use the following rake task: +We use [RSpec](http://rspec.info/) for testing. We have unit tests, functional tests and performance tests. To run tests use the following command: ```bash -rake spec +rspec ``` -### Installation - -```bash -$ rake install -``` - -The install rake task builds the gem and then installs it. You're all -set if you're using [RVM](http://rvm.beginrescueend.com/), but you may -need to run it with sudo if you have a system-installed Ruby: - -### Bumping Version - -It feels good to release code. Do it, do it often. But before that, bump -the version. Then release it. There's a few ways to update the version: - -```bash -# version:write like before -$ rake version:write MAJOR=0 MINOR=3 PATCH=0 - -# bump just major, ie 0.1.0 -> 1.0.0 -$ rake version:bump:major - -# bump just minor, ie 0.1.0 -> 0.2.0 -$ rake version:bump:minor - -# bump just patch, ie 0.1.0 -> 0.1.1 -$ rake version:bump:patch -``` - ---- - ### We're Hiring! Join the Netflix Studio Engineering team and help us build gems like this!