/craft-atom

A crafted and atomic component library for Java.

Primary LanguageJavaMIT LicenseMIT

craft-atom
A crafted and elegant atomic component library for Java. It is a maven multi-module java projects, each module is a crafted and atomic java library for specific feature.

This README is just a fast "quick start" document. You can find more detailed documentation here.

Philosophy

minimal Minimal code and dependency.
atomic Just do one thing right for every component.
compositional Compose atomic components for complex function.

How do I use it?

Use it as a maven dependency:

<dependency>
    <groupId>io.craftcode</groupId>
    <artifactId>craft-atom-xxx</artifactId>
    <version>3.1.0</version>
    <type>jar</type>
</dependency>

I want to contribute!

That is great!

  • Use Github issues to report bugs or for detailed feature requests.
  • Fork and create a topic branch, add your feature last post a pull request on github.

NOTICE:

  1. Please add unit tests in order to prove your modification works smoothly.
  2. Please make sure your modification passes all unit tests.
  3. Please respect coding style of craft.

Thanks for helping!

License

See LICENSE.