Skip to content

Latest commit

 

History

History
41 lines (26 loc) · 1.29 KB

README.md

File metadata and controls

41 lines (26 loc) · 1.29 KB
Raw

Docker Image Analyzer

Travis (.org) Maven Central

Extracts, parses, and analyzes Docker images into Java objects with JSON mappings.

Getting Started

Add the dependency to your pom file:

<dependency>
  <groupId>com.rapid7.docker</groupId>
  <artifactId>docker-image-analyzer</artifactId>
  <version>0.1.3</version>
</dependency>

TODO: Usage example(s)

Development

Fork the repository and create a development branch in your fork. Working from the master branch in your fork is not recommended.

  1. Open your favorite IDE or text editor
  2. Make some changes
  3. Add some tests if needed
  4. Run the tests
  5. Push your changes
  6. Open a pull request

You can use mvn clean install to clean compile, run checkstyle, and run all tests.

Code Style

docker-image-analyzer uses a variation of the Google Java code style, enforced with Checkstyle. Please make sure your changes adhere to this style before submitting a pull request.

Testing

Run mvn test or mvn clean install.