salesforce_certification_calculator 0.2.3 → 0.2.4

Sign up to get free protection for your applications and to get access to all the features.
Files changed (3) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +13 -2
  3. metadata +1 -1
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: d3e2c79e3592dc37772b3e758787237aee2a59eb61fdf6bb79e69a2922fb409c
4
- data.tar.gz: f71f648b7227e328e16e914d1285f53242c3b5d35456c1c59971924f6087cf52
3
+ metadata.gz: c6cd3c2dd6799ce7b8249d9651553b869544681b35622118147642aefe6eaa19
4
+ data.tar.gz: 98bddd3304510dcfd2b47b844d9a8f4385297a3c0c2fd214c826dbcdf632a251
5
5
  SHA512:
6
- metadata.gz: 75e7530e1274da33a63de6705ae6d024cd8aa736266b74dcd4c01623303fbd4ce2bfdcab96f67423c3451265d84b6cfe03473d3ac867e29148631291b554eaa3
7
- data.tar.gz: 200ce30ad30d7841a0fa37f03f86b2ca1d34b3391e6d75fed0604c38bcac88bd77c680ca1268dd567a275889753fad7e3f35b807d9f4b7b8b67f2fcf10eb9814
6
+ metadata.gz: 433f1b4df8363609831ce77597db9a052fea4c3303ab840bee07376e35334b384ab9cb142c745fd02057f1a30bf118402c4a4b28dc52a69341e40794f06c70d8
7
+ data.tar.gz: 3f588ef7f3f53d504f837a9539260e4f106554f00fcc01d9f75100010aa75cf7732e54eef5b80d19231274221380551baa0a9cee6c9357fac0d8dda70be1f5b6
data/README.md CHANGED
@@ -28,6 +28,7 @@ I've taken a few Salesforce certification exams in my day, and I was always anno
28
28
  - File reading functionality
29
29
  - User interface for the CLI to provide prompts to walk user through the input process
30
30
  - Methods for calculating the cumulative total and for walking the user through all stages of data collection
31
+ - Executable to allow user to run the module's core functionality with a simple command in the CLI instead of needing to go into a Ruby shell
31
32
 
32
33
  ## Requirements
33
34
 
@@ -65,14 +66,16 @@ If you have trouble downloading the package or just want to play around with the
65
66
  1. Fork this repository
66
67
  2. Clone it to your local computer
67
68
  3. From within your local version of the directory, build the module: `gem build salesforce_certification_calculator.gemspec`
68
- 4. Then install that built module: `gem install ./salesforce_certification_calculator-0.2.3.gem`
69
+ 4. Then install that built module: `gem install ./salesforce_certification_calculator-0.2.4.gem`
69
70
  5. Open a Ruby environment to use the module: `irb`
70
71
  6. Execute any of the recently installed methods
71
72
 
72
- You may need to update the specific version of the build as later releases come out (e.g., `-0.2.3.gem` may need to become `-0.3.0.gem`).
73
+ You may need to update the specific version of the build as later releases come out (e.g., `-0.2.4.gem` may need to become `-0.3.0.gem`).
73
74
 
74
75
  ## Usage
75
76
 
77
+ ### Module
78
+
76
79
  1. Open a Ruby environment to use the module: `irb`
77
80
  2. Require the package: `require 'salesforce_certification_calculator'`
78
81
  3. Create a new calculator to use: `calculator = SalesforceCertificationCalculator.new`
@@ -81,6 +84,14 @@ You may need to update the specific version of the build as later releases come
81
84
 
82
85
  Of course, you may use any of the other methods provided by the package, but `determine_percentage_manually` is the core method.
83
86
 
87
+ ### Executable
88
+
89
+ This package also contains an executable, so you can run its core functionality (the above `determine_percentage_manually` method) directly from the CLI without needing to enter a Ruby shell:
90
+
91
+ ```
92
+ salesforce_certification_calculator
93
+ ```
94
+
84
95
  ## Documentation
85
96
 
86
97
  This project uses **YARD** for documentation generation. To view the published form, see the [documentation on the RubyDoc site](https://www.rubydoc.info/gems/salesforce_certification_calculator/). To view the docs locally, go to the `doc` folder. To generate the docs yourself, execute `rake yard` in the CLI from the root of your local copy of the project.
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: salesforce_certification_calculator
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.2.3
4
+ version: 0.2.4
5
5
  platform: ruby
6
6
  authors:
7
7
  - Jackson Reeves