Skip to content

Commit

Permalink
Rename Repo
Browse files Browse the repository at this point in the history
  • Loading branch information
johannesduesing committed Sep 5, 2024
1 parent 314f693 commit 7230b7f
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 10 deletions.
6 changes: 0 additions & 6 deletions Maven-Central-Research-Interface.iml

This file was deleted.

8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down Expand Up @@ -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* ```

Expand Down
File renamed without changes

0 comments on commit 7230b7f

Please sign in to comment.