diff --git a/README.md b/README.md index bec30d1acb..e239f8cd5b 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,8 @@ ![Alt](https://repobeats.axiom.co/api/embed/aaedbff1e1adfcefc54fff9dbdac2f5384cbcf87.svg "Repobeats analytics image") +[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.github.tsantalis/refactoring-miner/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.github.tsantalis/refactoring-miner) + + Table of Contents ================= @@ -9,6 +12,7 @@ Table of Contents * [How to build RefactoringMiner](#how-to-build-refactoringminer) * [How to test RefactoringMiner](#how-to-test-refactoringminer) * [How to use RefactoringMiner as a maven dependency](#how-to-use-refactoringminer-as-a-maven-dependency) + * [How to use RefactoringMiner as a docker image](#how-to-use-refactoringminer-as-a-docker-image) * [Chrome extension](#chrome-extension) * [Research](#research) * [How to cite RefactoringMiner](#how-to-cite-refactoringminer) @@ -317,6 +321,12 @@ In order to use RefactoringMiner as a maven dependency in your project, add the implementation 'com.github.tsantalis:refactoring-miner:3.0.4' +# How to use RefactoringMiner as a docker image + + +Since version 3.0, RefactoringMiner is available in [DockerHub](https://hub.docker.com/r/tsantalis/refactoringminer). +A new image is created automatically on every Monday midnight. +You can find detailed instructions on how to install and use the image at [Docker README](https://github.com/tsantalis/RefactoringMiner/blob/master/docker/README.md). # Chrome Extension If you want to get refactoring information when inspecting a commit on GitHub,