diff --git a/README.md b/README.md new file mode 100644 index 0000000..954e59f --- /dev/null +++ b/README.md @@ -0,0 +1,41 @@ +Mon +=== + +TypeAlias for Java + +[![GitHub release](https://img.shields.io/github/release/kemitix/mon.svg)]() +[![Codacy Badge](https://api.codacy.com/project/badge/Grade/d57096b0639d496aba9a7e43e7cf5b4c)](https://www.codacy.com/app/kemitix/mon?utm_source=github.com&utm_medium=referral&utm_content=kemitix/mon&utm_campaign=Badge_Grade) +[![Build Status](https://travis-ci.org/kemitix/mon.svg?branch=master)](https://travis-ci.org/kemitix/mon) +[![Coverage Status](https://coveralls.io/repos/github/kemitix/mon/badge.svg?branch=master)](https://coveralls.io/github/kemitix/mon?branch=master) +[![codecov](https://codecov.io/gh/kemitix/mon/branch/master/graph/badge.svg)](https://codecov.io/gh/kemitix/mon) + +## Maven + +```xml + + net.kemitix + mon + ${mon.version} + +``` + +## Usage + +```java +class Goal extends TypeAlias { + private Goal(final String goal) { + super(goal); + } + public static Goal of(final String goal) { + return new Goal(goal); + } +} +``` + +```java +Goal goal = Goal.of("goal"); + +void foo(final Goal goal) { + System.out.println("The goal is " + goal.getValue()); +} +```