Update structures and project documentation #1
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR updates the project structure and documentation for SingularityLib, including version updates, enhanced documentation, and workflow improvements.
- Bumped version from 2.1.4 to 2.2.0 and updated artifactId casing
- Enhanced README with comprehensive documentation, installation guide, and usage examples
- Updated copyright information and workflow name
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| pom.xml | Updated artifactId casing and version bump to 2.2.0 |
| README.md | Complete documentation overhaul with installation guide, usage examples, and project roadmap |
| LICENSE | Updated copyright holder name |
| .github/workflows/maven-package.yml | Updated workflow name to be more descriptive |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| <dependency> | ||
| <groupId>com.pinont</groupId> | ||
| <artifactId>singularitylib</artifactId> | ||
| <version>2.1.3</version> |
There was a problem hiding this comment.
The version in the installation example (2.1.3) doesn't match the current project version (2.2.0) from pom.xml. This should be updated to 2.2.0 to ensure users install the correct version.
| <version>2.1.3</version> | |
| <version>2.2.0</version> |
| ```xml | ||
| <dependency> | ||
| <groupId>com.pinont</groupId> | ||
| <artifactId>singularitylib</artifactId> |
There was a problem hiding this comment.
The artifactId in the installation example uses lowercase 'singularitylib', but the pom.xml shows 'SingularityLib' with capital letters. This inconsistency will cause dependency resolution to fail.
| <artifactId>singularitylib</artifactId> | |
| <artifactId>SingularityLib</artifactId> |
Update