Skip to content

Update README.md #247

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mercyblitz merged 2 commits into from
Mar 4, 2026
Merged

Update README.md #247

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1a250be
Update README with new modules and Javadocs
mercyblitz Mar 4, 2026
1d009fb
Merge branch 'dev' of https://github.com/mercyblitz/microsphere-java …
mercyblitz Mar 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 18 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,23 +37,30 @@ frameworks like Spring, making it a versatile addition to any Java developer's t
- JMX
- Versioning
- Annotation processing
- Tools
- Testing

## Modules

The framework is organized into several key modules:

Module | Purpose
----------------------------------|-------------------------------------------------------------------------------------------------
microsphere-java-core | Provides core utilities across various domains like annotations, collections, concurrency, etc.
microsphere-annotation-processor | Offers annotation processing capabilities for compile-time code generation
microsphere-java-dependencies | Manages dependency versions across the project
microsphere-java-parent | Parent POM with shared configurations
Module | Purpose
----------------------------------|-----------------------------------------------------------------------------------------------------
microsphere-java-annotations | Provides the common annotations for Microsphere Java projects.
microsphere-java-core | Provides the core utilities across various domains like annotations, collections, concurrency, etc.
microsphere-java-model | Provides the components and utilities across Java Language Model API.
microsphere-jdk-tools | Offers the components for Java tools.
microsphere-annotation-processor | Offers annotation processing capabilities for compile-time code generation.
microsphere-java-test | Provides the models and components for Java testing.
microsphere-java-dependencies | Manages dependency versions across the project.
microsphere-java-parent | Parent POM with shared configurations.

## Getting Started

The easiest way to get started is by adding the Microsphere Java BOM (Bill of Materials) to your project's pom.xml:

```xml

<dependencyManagement>
<dependencies>
...
Expand All @@ -73,6 +80,7 @@ The easiest way to get started is by adding the Microsphere Java BOM (Bill of Ma
Then add the specific modules you need:

```xml

<dependencies>
<!-- Core utilities -->
<dependency>
Expand Down Expand Up @@ -159,8 +167,12 @@ We welcome your contributions! Please read [Code of Conduct](./CODE_OF_CONDUCT.m

### JavaDoc

- [microsphere-java-annotations](https://javadoc.io/doc/io.github.microsphere-projects/microsphere-java-annotations)
- [microsphere-java-core](https://javadoc.io/doc/io.github.microsphere-projects/microsphere-java-core)
- [microsphere-java-model](https://javadoc.io/doc/io.github.microsphere-projects/microsphere-java-model)
- [microsphere-jdk-tools](https://javadoc.io/doc/io.github.microsphere-projects/microsphere-jdk-tools)
- [microsphere-annotation-processor](https://javadoc.io/doc/io.github.microsphere-projects/microsphere-annotation-processor)
- [microsphere-java-test](https://javadoc.io/doc/io.github.microsphere-projects/microsphere-java-test)

## License

Expand Down