Merge branch 'release/0.1.0'

nordtheme · Sep 26, 2016 · 9c40e72 · 9c40e72
2 parents 9b086c6 + b68bf1c
commit 9c40e72
Show file tree

Hide file tree

Showing 9 changed files with 400 additions and 13 deletions.
diff --git a/.idea/misc.xml b/.idea/misc.xml
diff --git a/.travis.yml b/.travis.yml
@@ -1,7 +1,7 @@
 # +++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 # title      Travis CI Build Configuration                +
 # project    nord-java                                    +
-# version    0.0.0                                        +
+# version    0.1.0                                        +
 # repository https://github.com/arcticicestudio/nord-java +
 # author     Arctic Ice Studio                            +
 # email      development@arcticicestudio.com              +

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,3 +3,20 @@
 <p align="center"><img src="https://cdn.travis-ci.org/images/favicon-c566132d45ab1a9bcae64d8d90e4378a.svg" width=24 height=24/> <a href="https://travis-ci.org/arcticicestudio/nord-java"><img src="https://img.shields.io/travis/arcticicestudio/nord-java/develop.svg"/></a> <img src="https://codecov.io/favicon.ico" width=24 height=24/> <a href="https://codecov.io/gh/arcticicestudio/nord-java"><img src="https://codecov.io/gh/arcticicestudio/nord-java/branch/develop/graph/badge.svg"/></a> <img src="https://assets-cdn.github.com/favicon.ico" width=24 height=24/> <a href="https://github.com/arcticicestudio/nord-java/releases/latest"><img src="https://img.shields.io/github/release/arcticicestudio/nord-java.svg"/></a> <a href="https://github.com/arcticicestudio/nord/releases/tag/v0.2.0"><img src="https://img.shields.io/badge/Nord-0.2.0-blue.svg"/></a> <img src="http://central.sonatype.org/favicon.ico" width=24 height=24/> <a href="http://search.maven.org/#search%7Cgav%7C1%7Cg%3A%22com.arcticicestudio%22%20AND%20a%3A%22nord-java%22"><img src="https://img.shields.io/maven-central/v/com.arcticicestudio/nord-java.svg"/></a> <img src="https://oss.sonatype.org/favicon.ico"/> <a href="https://oss.sonatype.org/content/repositories/snapshots/com/arcticicestudio/nord-java"><img src="https://img.shields.io/badge/snapshot----blue.svg"/></a></p>
 
 ---
+
+# 0.1.0 (2016-09-26)
+## Features
+Implemented the public API (@arcticicestudio, #1, 8949a9baa7adf73be66b7ac8e15dfa2b57b0ac92)  
+A basic usage guide for the public API can be found in the [README](https://github.com/arcticicestudio/nord-java/blob/develop/README.md#usage-guide) section.
+
+### API
+The entrypoint is the `com.arcticicestudio.nord.Nord` enum.  
+Every enum constant represents a color as `Color` object.
+
+The API provides static methods to get the HEX and RGB color code string as well as the `Color` object itself.
+
+| Package | Entity | Modifier | Method | Description |
+| ------------ | -------- | ------------ | ----------- |
+| `com.arcticicestudio.nord` | `Nord` | static | `+ hex(Color) : String` | Converts the `color` to the HEX identifier. |
+| `com.arcticicestudio.nord` | `Nord` | static | `+ rgb(Color) : String` | Converts the `color` to the RGB identifier. |
+| `com.arcticicestudio.nord` | `Nord` | - | `+ get() : Color` | Returns the color object. |
diff --git a/README.md b/README.md
@@ -17,18 +17,18 @@ You can get it from the <img src="http://central.sonatype.org/favicon.ico" width
 <dependency>
   <groupId>com.arcticicestudio</groupId>
   <artifactId>nord-java</artifactId>
-  <version></version>
+  <version>0.1.0</version>
 </dependency>
 ```
 
 <img src="https://gradle.org/wp-content/uploads/fbrfg/favicon.ico" width=16 height=16/> <a href="https://gradle.org">Gradle</a>
 ```java
-compile(group: 'com.arcticicestudio', name: 'nord-java', version: '')
+compile(group: 'com.arcticicestudio', name: 'nord-java', version: '0.1.0')
 ```
 
 <img src="http://apache.org/favicons/favicon.ico" width=16 height=16/> <a href="https://ant.apache.org/ivy">Apache Ivy</a>
 ```xml
-<dependency org="com.arcticicestudio" name="nord-java" rev="" />
+<dependency org="com.arcticicestudio" name="nord-java" rev="0.1.0" />
 ```
 
 Development snapshots are available via [OSS Sonatype](https://oss.sonatype.org/content/repositories/snapshots/com/arcticicestudio/nord-java).  
@@ -46,8 +46,30 @@ mvn clean install -Dgpg.keyname=YourGPGKeyId
 
 A continuous integration build is running at [Travis-CI](https://travis-ci.org/arcticicestudio/nord-java).
 
+## Usage Guide
+This is a basic guide to show the common usage of the nord-java API.  
+The API documentation can be found in the JavaDoc.
+
+The class `Nord` is the entrypoint to the nord-java API, use it to generate the HEX and RGB color codes.
+  - [Generate color code strings](#generate-color-code-strings)
+  - [Obtaining the Public API version](#obtaining-the-public-api-version)
+
+### Generate color code strings
+You can generate color code strings from all `Nord` enum variables by using the with the static methods `hex(Color)` and `rgb(Color)`.  
+The `Color` object can be obtained from a `Nord` enum variable via the `get()` method.  
+```java
+String hex = Nord.hex(Nord.NORD0.get()); // ""#2E3440"
+String rgb = Nord.rgb(Nord.NORD8.get()); // "rgb(136, 192, 208)""
+```
+
+### Obtaining the Public API version
+The method `getVersion()` returns the version of the public API as string.  
+```java
+String version = Nord.NORD0.getVersion(); // "0.1.0"
+```
+
 ## Development
-[![](https://img.shields.io/badge/Changelog-0.0.0-blue.svg)](https://github.com/arcticicestudio/nord-java/blob/develop/CHANGELOG.md) [![](https://img.shields.io/badge/Workflow-gitflow_Branching_Model-blue.svg)](http://nvie.com/posts/a-successful-git-branching-model) [![](https://img.shields.io/badge/Versioning-ArcVer_0.8.0-blue.svg)](https://github.com/arcticicestudio/arcver)
+[![](https://img.shields.io/badge/Changelog-0.1.0-blue.svg)](https://github.com/arcticicestudio/nord-java/blob/v0.1.0/CHANGELOG.md) [![](https://img.shields.io/badge/Workflow-gitflow_Branching_Model-blue.svg)](http://nvie.com/posts/a-successful-git-branching-model) [![](https://img.shields.io/badge/Versioning-ArcVer_0.8.0-blue.svg)](https://github.com/arcticicestudio/arcver)
 
 ### Contribution
 Please report issues/bugs, feature requests and suggestions for improvements to the [issue tracker](https://github.com/arcticicestudio/nord-java/issues).

diff --git a/nord-java.iml b/nord-java.iml
@@ -3,7 +3,6 @@
   <component name="NewModuleRootManager" LANGUAGE_LEVEL="JDK_1_8" inherit-compiler-output="false">
     <output url="file://$MODULE_DIR$/target/classes" />
     <output-test url="file://$MODULE_DIR$/target/test-classes" />
-    <exclude-output />
     <content url="file://$MODULE_DIR$">
       <sourceFolder url="file://$MODULE_DIR$/src/main/java" isTestSource="false" />
       <sourceFolder url="file://$MODULE_DIR$/src/main/resources" type="java-resource" />

diff --git a/pom.xml b/pom.xml
@@ -3,7 +3,7 @@
 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 title      POM                                          +
 project    nord-java                                    +
-version    0.0.0                                        +
+version    0.1.0                                        +
 repository https://github.com/arcticicestudio/nord-java +
 author     Arctic Ice Studio                            +
 email      development@arcticicestudio.com              +
@@ -28,7 +28,7 @@ JFrog Bintray
 
   <groupId>com.arcticicestudio</groupId>
   <artifactId>nord-java</artifactId>
-  <version>0.0.0</version>
+  <version>0.1.0</version>
   <packaging>jar</packaging>
 
   <name>nord-java</name>
@@ -212,9 +212,26 @@ JFrog Bintray
           <classifier>javadoc</classifier>
           <encoding>${project.build.sourceEncoding}</encoding>
           <author>true</author>
-          <bottom>Copyright &#169; {inceptionYear} {organizationName}</bottom>
+          <bottom>Copyright &#169; ${inceptionYear} {organizationName}</bottom>
           <doctitle>${project.name} ${project.version} API</doctitle>
           <windowtitle>${project.name} ${project.version} API</windowtitle>
+          <tags>
+            <tag>
+              <name>apiNote</name>
+              <placement>a</placement>
+              <head>API Note:</head>
+            </tag>
+            <tag>
+              <name>implSpec</name>
+              <placement>a</placement>
+              <head>Implementation Specification:</head>
+            </tag>
+            <tag>
+              <name>implNote</name>
+              <placement>a</placement>
+              <head>Implementation Note:</head>
+            </tag>
+          </tags>
         </configuration>
       </plugin>