inspec/lib/plugins/inspec-streaming-reporter-progress-bar/README.md

29 lines
906 B
Markdown
Raw Normal View History

# StreamingReporterProgressBar Plugin
This plugin was generated by `inspec init plugin`, and apparently the author, 'Nikita Mathur', did not update the README.
## To Install This Plugin
Assuming it has been published to RubyGems, you can install this gem using:
```
you@machine $ inspec plugin install inspec-streaming-reporter-progress-bar
```
## What This Plugin Does
No idea.
## Developing This Plugin
The generated plugin contains everything a real-world, industrial grade plugin would have, including:
* an (possibly incomplete) implementation of one or more InSpec Plugin Types
* documentation (you are reading it now)
* tests, at the unit and functional level
* a .gemspec, for packaging and publishing it as a gem
* a Gemfile, for managing its dependencies
* a Rakefile, for running development tasks
* Rubocop linting support for using the base InSpec project rubocop.yml (See Rakefile)