From 9e9ffa8ab1aa79dfa685cf6fa2ad85b4c467bdd5 Mon Sep 17 00:00:00 2001 From: Erich Soares Machado Date: Thu, 1 Feb 2018 15:26:40 +0100 Subject: [PATCH 1/8] Fixes the markdown code highlighting for the 'Bumping Version' section --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b940e7a..8965eb8 100644 --- a/README.md +++ b/README.md @@ -215,7 +215,7 @@ need to run it with sudo if you have a system-installed ruby: 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: -```ruby +```bash # version:write like before $ rake version:write MAJOR=0 MINOR=3 PATCH=0 From 24f0377e8d079ac9817af42b50020d3b7280aac9 Mon Sep 17 00:00:00 2001 From: Erich Soares Machado Date: Thu, 1 Feb 2018 15:28:39 +0100 Subject: [PATCH 2/8] Small corrections on the 'Installation' README section --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8965eb8..8040f4a 100644 --- a/README.md +++ b/README.md @@ -206,9 +206,9 @@ rake spec $ rake install ``` -The install rake task builds the gem installs it. You're all +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: +need to run it with sudo if you have a system-installed Ruby: ### Bumping Version From 80a244d9d2cdb2f1711acd67efcbb9e660874304 Mon Sep 17 00:00:00 2001 From: Erich Soares Machado Date: Thu, 1 Feb 2018 15:30:02 +0100 Subject: [PATCH 3/8] Small corrections on the 'Running Tests' README section --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 8040f4a..fd98287 100644 --- a/README.md +++ b/README.md @@ -194,7 +194,7 @@ rake gemspec ``` ### Running Tests -We use rspec 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 rake task: ```bash rake spec From 472553a97db97dc73a0145596e3ac2d910d18f47 Mon Sep 17 00:00:00 2001 From: Erich Soares Machado Date: Thu, 1 Feb 2018 15:33:47 +0100 Subject: [PATCH 4/8] Add missing colon on the 'Updating Project Information' README section --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index fd98287..697bf50 100644 --- a/README.md +++ b/README.md @@ -187,7 +187,7 @@ 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 +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 From 913cb21aca67484c2a598a296f587769ecc84e49 Mon Sep 17 00:00:00 2001 From: Erich Soares Machado Date: Thu, 1 Feb 2018 15:35:38 +0100 Subject: [PATCH 5/8] Fixes highlighting on the 'Installation' README section --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 697bf50..6722a20 100644 --- a/README.md +++ b/README.md @@ -48,7 +48,7 @@ gem 'fast_jsonapi' Execute: -```ruby +```bash $ bundle install ``` From 2833cff589ff12215b7a7e2d9f2e5c5b93a910aa Mon Sep 17 00:00:00 2001 From: Erich Soares Machado Date: Thu, 1 Feb 2018 15:37:29 +0100 Subject: [PATCH 6/8] Small fixes on the Features 'README' section --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 6722a20..e627304 100644 --- a/README.md +++ b/README.md @@ -32,8 +32,8 @@ We compare serialization times with Active Model Serializer as part of RSpec per ## Features -* Declaration syntax similar to Active Model serializer -* Support for belongs_to, has_many and has_one +* Declaration syntax similar to Active Model Serializer +* Support for `belongs_to`, `has_many` and `has_one` * Support for compound documents (included) * Optimized serialization of compound documents * Caching From d580fd44ef123880fd9e15f29c514747b9ba650d Mon Sep 17 00:00:00 2001 From: Erich Soares Machado Date: Thu, 1 Feb 2018 15:38:06 +0100 Subject: [PATCH 7/8] Fixes 'Performance Comparison' README section title --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e627304..b848a8f 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ A lightning fast [JSON:API](http://jsonapi.org/) serializer for Ruby Objects. -# Performance Comparision +# Performance Comparison We compare serialization times with Active Model Serializer as part of RSpec performance tests included on this library. We want to ensure that with every change on this library, serialization time is at least `25 times` faster than Active Model Serializers on up to current benchmark of 1000 records. From f4e075f34e9df4edc129aadc938be6e6ca33271f Mon Sep 17 00:00:00 2001 From: Erich Soares Machado Date: Thu, 1 Feb 2018 15:40:31 +0100 Subject: [PATCH 8/8] Fixes 'Benchmark times for 250 records' README section identation --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index b848a8f..2a43354 100644 --- a/README.md +++ b/README.md @@ -11,9 +11,9 @@ We compare serialization times with Active Model Serializer as part of RSpec per ## Benchmark times for 250 records ```bash - $ rspec - Active Model Serializer serialized 250 records in 138.71 ms - Fast JSON API serialized 250 records in 3.01 ms +$ rspec +Active Model Serializer serialized 250 records in 138.71 ms +Fast JSON API serialized 250 records in 3.01 ms ``` # Table of Contents