README.md in ojra-1.0.2 vs README.md in ojra-1.1.0
- old
+ new
@@ -1,9 +1,12 @@
# OJRA: Open Journals Reviewers API
A Ruby wrapper for the Open Journal's Reviewers application's API
+[![Tests](https://github.com/xuanxu/ojra/actions/workflows/tests.yml/badge.svg)](https://github.com/xuanxu/ojra/actions/workflows/tests.yml)
+[![Gem Version](https://badge.fury.io/rb/ojra.svg)](https://badge.fury.io/rb/ojra)
+
## Use
### Installation
Install OJRA running:
@@ -30,29 +33,33 @@
### Available methods
**STATS:**
- - **assign_reviewer(reviewer, issue_id)**: Add a new active review to a reviewers' stats
+ - **assign_reviewers(reviewers_list, issue_id)**: Add a new active review to a reviewer or list of reviewers (array or comma separated string)
```ruby
- client.assign_reviewer("reviewer21", 4321)
+ client.assign_reviewers("@reviewer21", 4321)
+ client.assign_reviewers("@reviewer21, @reviewer33, @reviewer42", 4321)
+ client.assign_reviewers(["reviewer21", "reviewer33", "reviewer42"], 4321)
```
- - **assign_reviewers(reviewers_list, issue_id)**: Add a new active review to a list of reviewers (array or comma separated string)
+ - **unassign_reviewers(reviewers_list, issue_id)**: Log a review unassignment for a reviewer or list of reviewers (array or comma separated string)
```ruby
- client.assign_reviewers("@reviewer21, @reviewer33, @reviewer42", 4321)
- client.assign_reviewers(["reviewer21", "reviewer33", "reviewer42"], 4321)
+ client.unassign_reviewers("@reviewer21, @reviewer33, @reviewer42", 4321)
+ client.unassign_reviewers("@reviewer21", 4321)
+ client.unassign_reviewers(["reviewer21", "reviewer33", "reviewer42"], 4321)
```
-
- - **unassign_reviewer(reviewer, issue_id)**: Log end of review for a reviewer
+ - **start_review(reviewers_list, issue_id)**: Log starting a review for a reviewer or list of reviewers (array or comma separated string)
```ruby
- client.unassign_reviewer("@reviewer21", 4321)
+ client.start_review("@reviewer21", 4321)
+ client.start_review("@reviewer21, @reviewer33, @reviewer42", 4321)
+ client.start_review(["reviewer21", "reviewer33", "reviewer42"], 4321)
```
-
- - **unassign_reviewers(reviewers_list, issue_id)**: Log end of review for a list of reviewers (array or comma separated string)
+ - **finish_review(reviewers_list, issue_id)**: Log end of review for a reviewer or list of reviewers (array or comma separated string)
```ruby
- client.unassign_reviewers("@reviewer21, @reviewer33, @reviewer42", 4321)
- client.unassign_reviewers(["reviewer21", "reviewer33", "reviewer42"], 4321)
+ client.finish_review("@reviewer21", 4321)
+ client.finish_review("@reviewer21, @reviewer33, @reviewer42", 4321)
+ client.finish_review(["reviewer21", "reviewer33", "reviewer42"], 4321)
```