search

sumoheavy / jira-ruby

A Ruby gem for the JIRA REST API
MIT License
654 stars 412 forks source link

Update README.md to include useage examples in the example.rb file #417

Closed rjrobinson closed 4 months ago

rjrobinson commented 9 months ago

Documentation: Enhanced Usage Examples

  1. Revised explanation on how fields can be referred by custom names, emphasizing the unique PascalCase-snake_case mixed naming convention used after mapping.
  2. Added examples to demonstrate usage of the JIRA-Ruby gem, such as connecting to a JIRA instance, retrieving and displaying project details, handling fields by names, performing JQL queries, and executing various actions on the Issue object.
  3. Elaborated on the additional capabilities of the API wrapper like searching for a user, managing issue links, etc., urging users to refer to the complete script for a comprehensive idea of the gem's functionality.