unitxc/readme.md

47 lines
1 KiB
Markdown

FF-UnitXC
=========
FF-UnitXC is a java8 library providing a cross unit converter.
NOTE: Status is in progress.
## Features
* Many units provided.
* Unit groups.
* Unit flags.
* Full metric system.
* Imperial values.
* Weird SI units.
## Installation
Add maven deps;
<dependency>
<groupId>net.forwardfire.unitxc</groupId>
<artifactId>ff-unitxc-converter</artifactId>
<version>0.0.1-SNAPSHOT</version>
<scope>compile</scope>
</dependency>
## Files in this package
* build.md - Developer build commands.
* license.txt - The license of ff-unitxc.
* pom.xml - Maven specific build file.
* readme.md - This file.
* todo.md - Small todo list.
* src - Site source.
## Contributing
In lieu of a formal styleguide, take care to maintain the existing coding style.
Add unit tests for any new or changed functionality. Style and test your code.
## Release History
### Version 0.0.1
* First public release