cyberark / conjur-inspect

Apache License 2.0
3 stars 0 forks source link

Improve README to explain tool usage #33

Closed micahlee closed 1 year ago

micahlee commented 1 year ago

Desired Outcome

The desired outcome of this PR is to add sufficient information to the README to allow successful execution of the tool for validating a Conjur container host machine.

Implemented Changes

This PR expands the usage and installation instructions, as well as details for inspecting disk performance.

Connected Issue/Story

CyberArk internal issue ID: CNJR-484

Definition of Done

At least 1 todo must be completed in the sections below for the PR to be merged.

Changelog

Test coverage

Documentation

Behavior

Security

codeclimate[bot] commented 1 year ago

Code Climate has analyzed commit ee17833a and detected 8 issues on this pull request.

Here's the issue category breakdown:

Category Count
Style 8

The test coverage on the diff in this pull request is 100.0% (50% is the threshold).

This pull request will bring the total coverage in the repository to 94.2% (0.0% change).

View more on Code Climate.