From 7230b7fa246dea8106732bd7896b296d03d7ae8c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Johannes=20D=C3=BCsing?= Date: Thu, 5 Sep 2024 13:02:41 +0200 Subject: [PATCH] Rename Repo --- Maven-Central-Research-Interface.iml | 6 ------ README.md | 8 ++++---- .../artifact_class_structure.svg | 0 3 files changed, 4 insertions(+), 10 deletions(-) delete mode 100644 Maven-Central-Research-Interface.iml rename artifact_class_structure.svg => docs/artifact_class_structure.svg (100%) diff --git a/Maven-Central-Research-Interface.iml b/Maven-Central-Research-Interface.iml deleted file mode 100644 index 9e3449c..0000000 --- a/Maven-Central-Research-Interface.iml +++ /dev/null @@ -1,6 +0,0 @@ - - - - - \ No newline at end of file diff --git a/README.md b/README.md index b4db74a..a9b29ba 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ -# Maven Central Research Interface -An interface focused on creating an accessible and scalable way to do research on artifacts on the Maven Central repository. The MCRI contains an overarching implementation of the different modules in the interface, allowing for quick and repeated analysis runs to be performed. +# MARIN (MAven Research INterface) +An interface focused on creating an accessible and scalable way to do research on artifacts on the Maven Central repository. MARIN contains an overarching implementation of the different modules in the interface, allowing for quick and repeated analysis runs to be performed. ## Required Java Version - The Maven Central Research Interface requires Java 11. +The Maven Research Interface requires Java 11. ## MavenCentralAnalysis An abstract class that can be extended to easily run a multitude of analyses on artifacts of the Maven Central repository. Boolean values are used to control which type of information to collect (index, pom, jar) and a cli is in place to configure other aspects of the run. @@ -37,7 +37,7 @@ The CLI includes the following: - usage: ```--multi threads``` ## Usage -To use Maven Central Research Interface extend the Maven Central Analysis class and implement the analyzeArtifact() method with the data that you are trying to extract. From there create an instance of your implementation in main, then build the project, and use the cli to fully customize the analysis. +To use MARIN, extend the Maven Central Analysis class and implement the analyzeArtifact() method with the data that you are trying to extract. From there create an instance of your implementation in main, then build the project, and use the cli to fully customize the analysis. ```java -jar executableName *INSERT CLI HERE* ``` diff --git a/artifact_class_structure.svg b/docs/artifact_class_structure.svg similarity index 100% rename from artifact_class_structure.svg rename to docs/artifact_class_structure.svg