Skip to content

Commit a05ccca

Browse files
svengrebsvengreb
committed
Migrate to the nordtheme organization
As part of the "Northern Post - The state and roadmap of Nord" [2] initiative, this repository will be migrated to the `nordtheme` GitHub organization [1]. This included the temporary removal of documentation, since this is outdated by far anyway, and the move to the `nordtheme` organization as a kind of "test subject" in order to ensure that all required metadata and information, e.g. stars and watchers, will be migrated. Note that the documentation will be recreated as part of the data transition [3] later on again, following the new project structure and layout conventions. [1]: https://github.com/nordtheme [2]: nordtheme/nord#180 [3]: nordtheme/web#133 GH-13
1 parent af44196 commit a05ccca

File tree

3 files changed

+95
-91
lines changed

3 files changed

+95
-91
lines changed

‎CHANGELOG.md

+49-8
Original file line numberDiff line numberDiff line change
@@ -1,52 +1,93 @@
1-
<p align="center"><img src="https://cdn.rawgit.com/arcticicestudio/nord-java/develop/src/main/assets/nord-java-banner.svg"/></p>
1+
<p align="center">
2+
<a href="https://www.nordtheme.com" target="_blank">
3+
<picture>
4+
<source srcset="https://raw.githubusercontent.com/nordtheme/assets/main/static/images/logos/heroes/logo-typography/dark/frostic/nord3/spaced.svg?sanitize=true" width="100%" media="(prefers-color-scheme: light), (prefers-color-scheme: no-preference)" />
5+
<source srcset="https://raw.githubusercontent.com/nordtheme/assets/main/static/images/logos/heroes/logo-typography/light/frostic/nord6/spaced.svg?sanitize=true" width="100%" media="(prefers-color-scheme: dark)" />
6+
<img src="https://raw.githubusercontent.com/nordtheme/assets/main/static/images/logos/heroes/logo-typography/dark/frostic/nord3/spaced.svg?sanitize=true" width="100%" />
7+
</picture>
8+
</a>
9+
</p>
210

311
<p align="center"><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-java/releases/latest"><img src="https://img.shields.io/badge/pre--release---_-blue.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-0.2.0--SNAPSHOT-blue.svg"/></a> <img src="https://bintray.com/favicon.ico" width=24 height=24/> <a href='https://bintray.com/arcticicestudio/Nord/nord-java/_latestVersion'><img src='https://api.bintray.com/packages/arcticicestudio/Nord/nord-java/images/download.svg'></a> <img src="https://oss.jfrog.org/webapp/images/favicon.40285.ico" width=24 height=24/> <a href="https://oss.jfrog.org/webapp/#/artifacts/browse/tree/General/oss-snapshot-local/com/arcticicestudio/nord-java"><img src="https://img.shields.io/badge/artifactory-0.2.0--SNAPSHOT-green.svg"/></a></p>
412

5-
---
6-
713
# 0.2.0 (2016-12-03)
14+
815
## Improvements
16+
917
### Public API
18+
1019
The public API method `getVersion() : String` is now static and returns the `String` constant `VERSION` to adapt to the SonarQube minor rule [squid:S3400](https://sonarqube.com/coding_rules#q=squid%3AS3400).
1120
The associated unit test has been refactored to test against the [ArcVer](https://github.com/arcticicestudio/arcver) library [arcver-java](https://github.com/arcticicestudio/arcver). (@arcticicestudio, #8, 7efc44cc)
1221

1322
The attribute
23+
1424
```java
1525
private final Color COLOR;
1626
```
27+
1728
conflicted with the SonarQube rule [squid:S00116](https://sonarqube.com/coding_rules#q=squid%3AS00116) and has been adapted to the Arctic Ice Studio Java code style. (@arcticicestudio, #9, 8eb03e63)
1829

1930
### Toolbox
31+
2032
Fixed the deprecated POM variable `${inceptionYear}` and replaced it with `${project.inceptionYear}`. (@arcticicestudio, #3, 1a02e6d2)
2133

2234
Added POM profiles for [JFrog Bintray](https://bintray.com) to deploy Maven artifacts to the [jCenter](https://bintray.com/bintray/jcenter) and snapshots to the [OSS JFrog](https://oss.jfrog.org) repository. (@arcticicestudio, #4, f74c7a57)
2335

2436
### Public API Documentation
37+
2538
Adapted the documentation style of the Nord color palette project to the JavaDoc. (@arcticicestudio, #7, 9eab5800)
2639

2740
## Bug Fixes
41+
2842
### Public API Documentation
43+
2944
Fixed malformed JavaDoc to prevent compilation errors caused by the new JavaDoc linter rules introduced JDK 8u92 by adding the `summary` attribute to `table` tags. (@arcticicestudio, #3, 1a02e6d2)
3045

3146
## Tasks
47+
3248
### Toolbox
49+
3350
Created a `circle.yml` configuration file to add [Circle CI](https://circleci.com) build integration. (@arcticicestudio, #6, f241e8de)
3451

3552
Added the `maven-assembly-plugin` as `assemble` POM profile (@arcticicestudio, #5, 9f6e438d)
3653

3754
# 0.1.0 (2016-09-26)
55+
3856
## Features
57+
3958
Implemented the public API (@arcticicestudio, #1, 8949a9baa7adf73be66b7ac8e15dfa2b57b0ac92)
4059
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.
4160

4261
### API
62+
4363
The entrypoint is the `com.arcticicestudio.nord.Nord` enum.
4464
Every enum constant represents a color as `Color` object.
4565

4666
The API provides static methods to get the HEX and RGB color code string as well as the `Color` object itself.
4767

48-
| Package | Entity | Modifier | Method | Description |
49-
| ------------ | -------- | ------------ | ----------- |
50-
| `com.arcticicestudio.nord` | `Nord` | static | `+ hex(Color) : String` | Converts the `color` to the HEX identifier. |
51-
| `com.arcticicestudio.nord` | `Nord` | static | `+ rgb(Color) : String` | Converts the `color` to the RGB identifier. |
52-
| `com.arcticicestudio.nord` | `Nord` | - | `+ get() : Color` | Returns the color object. |
68+
| Package | Entity | Modifier | Method | Description |
69+
| -------------------------- | ------ | -------- | ----------------------- | ------------------------------------------- |
70+
| `com.arcticicestudio.nord` | `Nord` | static | `+ hex(Color) : String` | Converts the `color` to the HEX identifier. |
71+
| `com.arcticicestudio.nord` | `Nord` | static | `+ rgb(Color) : String` | Converts the `color` to the RGB identifier. |
72+
| `com.arcticicestudio.nord` | `Nord` | - | `+ get() : Color` | Returns the color object. |
73+
74+
<p align="center">
75+
<picture>
76+
<source srcset="https://raw.githubusercontent.com/nordtheme/assets/main/static/images/elements/separators/iceberg/footer/dark/spaced.svg?sanitize=true" width="100%" media="(prefers-color-scheme: light), (prefers-color-scheme: no-preference)" />
77+
<source srcset="https://raw.githubusercontent.com/nordtheme/assets/main/static/images/elements/separators/iceberg/footer/light/spaced.svg?sanitize=true" width="100%" media="(prefers-color-scheme: dark)" />
78+
<img src="https://raw.githubusercontent.com/nordtheme/assets/main/static/images/elements/separators/iceberg/footer/dark/spaced.svg?sanitize=true" width="100%" />
79+
</picture>
80+
</p>
81+
82+
<p align="center">
83+
Copyright &copy; 2016-present <a href="https://www.svengreb.de" target="_blank">Sven Greb</a>
84+
</p>
85+
86+
<p align="center">
87+
<a href="https://github.com/nordtheme/java/blob/main/license" target="_blank">
88+
<img src="https://img.shields.io/static/v1.svg?style=flat-square&label=License&message=MIT&logoColor=eceff4&logo=creativecommons&colorA=4c566a&colorB=88c0d0"/>
89+
</a>
90+
<a href="https://www.svengreb.de">
91+
<img src="https://img.shields.io/static/v1.svg?style=flat-square&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QA/wD/AP+gvaeTAAABMklEQVQ4jcWQvUoDQRRGz52s5IfVIiDWPkGKFFaCIVaGdIagjcFAwICFb7DvIK6QQlNpY2UQLMQVBbEQ0SewFkGbKCQmOzaTJay7/lR+zTAf9xwuF/47Mv45rdezqWEq72v/RWZnHgqOMwDwHMfSj085JSqb6Pu38we7r18E3nqzhmYbsE11rxKsAvhDfQiSM30XYbOw57YDwfnaRl6U3ABWaMNn806H+oGPzBX3d+4UgChZiYBHYBgGsBLoKoAyhR0x9G20Zmpc4P1ZoMQDcwMNclFrdhBKv6M5WWi7ZQGtjEUn35IV4OwnVjSX/WGmKqCDDUa5rmyle3bvGFiMg3WGUsF1u0EXHoqTRMGRgkAy2eugKZrqijRLYThWANBpNDL2h3UE0J0YLJdbrfe42f/NJ0wqY7/KcXKPAAAAAElFTkSuQmCC&label=lovely%20crafted%20in&message=Germany&colorA=4c566a&colorB=88c0d0"/>
92+
</a>
93+
</p>

‎README.md

+45-81
Original file line numberDiff line numberDiff line change
@@ -1,81 +1,45 @@
1-
<p align="center"><img src="https://cdn.rawgit.com/arcticicestudio/nord-java/develop/src/main/assets/nord-java-banner.svg"/></p>
2-
3-
<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://circleci.com/favicon.ico" width=24 height=24/> <a href="https://circleci.com/gh/arcticicestudio/nord-java"><img src="https://circleci.com/gh/arcticicestudio/nord-java.svg?style=shield&circle-token=d2d78e04b95f505e0c6a870913f96ee9912bb4c0"/></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-java/releases/latest"><img src="https://img.shields.io/badge/pre--release---_-blue.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> <img src="https://bintray.com/favicon.ico" width=24 height=24/> <a href='https://bintray.com/arcticicestudio/Nord/nord-java/_latestVersion'><img src='https://api.bintray.com/packages/arcticicestudio/Nord/nord-java/images/download.svg'></a> <img src="https://oss.jfrog.org/webapp/images/favicon.40285.ico" width=24 height=24/> <a href="https://oss.jfrog.org/webapp/#/artifacts/browse/tree/General/oss-snapshot-local/com/arcticicestudio/nord-java"><img src="https://img.shields.io/badge/artifactory---_-green.svg"/></a></p>
4-
5-
<p align="center">A arctic, north-bluish color palette Java library.<br>
6-
Implementation of the <a href="https://github.com/arcticicestudio/nord">Nord</a> project.</p>
7-
8-
---
9-
10-
## Getting started
11-
### Setup
12-
To use nord-java, it must be available on your classpath.
13-
You can get it from the <img src="http://central.sonatype.org/favicon.ico" width=16 height=16/> <a href="https://search.maven.org">Central Repository</a> as a dependency for your favorite build tool or [download the latest version](https://github.com/arcticicestudio/nord-java/releases/latest).
14-
15-
<img src="http://apache.org/favicons/favicon.ico" width=16 height=16/> <a href="https://maven.apache.org">Apache Maven</a>
16-
```xml
17-
<dependency>
18-
<groupId>com.arcticicestudio</groupId>
19-
<artifactId>nord-java</artifactId>
20-
<version>0.2.0</version>
21-
</dependency>
22-
```
23-
24-
<img src="https://gradle.org/wp-content/uploads/fbrfg/favicon.ico" width=16 height=16/> <a href="https://gradle.org">Gradle</a>
25-
```java
26-
compile(group: 'com.arcticicestudio', name: 'nord-java', version: '0.2.0')
27-
```
28-
29-
<img src="http://apache.org/favicons/favicon.ico" width=16 height=16/> <a href="https://ant.apache.org/ivy">Apache Ivy</a>
30-
```xml
31-
<dependency org="com.arcticicestudio" name="nord-java" rev="0.2.0" />
32-
```
33-
34-
Development snapshots are available via [OSS Sonatype](https://oss.sonatype.org/content/repositories/snapshots/com/arcticicestudio/nord-java) and [JFrog Artifactory](https://oss.jfrog.org/webapp/#/artifacts/browse/tree/General/oss-snapshot-local/com/arcticicestudio/nord-java).
35-
36-
### Build
37-
Build and install nord-java into your local repository without GPG signing:
38-
```
39-
mvn clean install
40-
```
41-
42-
Signed artifacts may be build by using the `sign-gpg` profile with a provided `gpg.keyname` property:
43-
```
44-
mvn clean install -Dgpg.keyname=YourGPGKeyId
45-
```
46-
47-
Continuous integration builds are running at [Travis-CI](https://travis-ci.org/arcticicestudio/nord-java) and [Circle CI](https://circleci.com/bb/arcticicestudio/nord-java).
48-
49-
## Usage Guide
50-
This is a basic guide to show the common usage of the nord-java API.
51-
The API documentation can be found in the JavaDoc.
52-
53-
The class `Nord` is the entrypoint to the nord-java API, use it to generate the HEX and RGB color codes.
54-
1. [Generate color code strings](#generate-color-code-strings)
55-
2. [Obtaining the Public API version](#obtaining-the-public-api-version)
56-
57-
### Generate color code strings
58-
Color code strings can be generated from all `Nord` enum constants by using the static methods `hex(Color)` and `rgb(Color)`.
59-
The `Color` object can be obtained from a `Nord` enum variable via the `get()` method.
60-
```java
61-
String hex = Nord.hex(Nord.NORD0.get()); // "#2E3440"
62-
String rgb = Nord.rgb(Nord.NORD8.get()); // "rgb(136, 192, 208)"
63-
```
64-
65-
### Obtaining the Public API version
66-
The `getVersion()` method returns the [ArcVer](https://github.com/arcticicestudio/arcver) version of the public API.
67-
```java
68-
String version = Nord.getVersion(); // "0.2.0"
69-
```
70-
71-
## Development
72-
[![](https://img.shields.io/badge/Changelog-0.2.0-blue.svg)](https://github.com/arcticicestudio/nord-java/blob/v0.2.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)
73-
74-
### Contribution
75-
Please report issues/bugs, feature requests and suggestions for improvements to the [issue tracker](https://github.com/arcticicestudio/nord-java/issues).
76-
77-
<p align="center"><img src="https://cdn.rawgit.com/arcticicestudio/nord/develop/src/assets/banner-footer-mountains.svg"/></p>
78-
79-
<p align="center">Copyright &copy; 2016-present Arctic Ice Studio</p>
80-
81-
<p align="center"><a href="https://github.com/arcticicestudio/nord-java/blob/develop/LICENSE.md"><img src="https://img.shields.io/badge/License-MIT-5E81AC.svg?style=flat-square"/></a> <a href="https://creativecommons.org/licenses/by-sa/4.0"><img src="https://img.shields.io/badge/License-CC_BY--SA_4.0-5E81AC.svg?style=flat-square"/></a></p>
1+
<p align="center">
2+
<a href="https://www.nordtheme.com" target="_blank">
3+
<picture>
4+
<source srcset="https://raw.githubusercontent.com/nordtheme/assets/main/static/images/logos/heroes/logo-typography/dark/frostic/nord3/spaced.svg?sanitize=true" width="100%" media="(prefers-color-scheme: light), (prefers-color-scheme: no-preference)" />
5+
<source srcset="https://raw.githubusercontent.com/nordtheme/assets/main/static/images/logos/heroes/logo-typography/light/frostic/nord6/spaced.svg?sanitize=true" width="100%" media="(prefers-color-scheme: dark)" />
6+
<img src="https://raw.githubusercontent.com/nordtheme/assets/main/static/images/logos/heroes/logo-typography/dark/frostic/nord3/spaced.svg?sanitize=true" width="100%" />
7+
</picture>
8+
</a>
9+
</p>
10+
11+
<p align="center">
12+
<a href="https://github.com/nordtheme/java/releases/latest" target="_blank">
13+
<img src="https://img.shields.io/github/release/nordtheme/assets.svg?style=flat-square&label=Release&logo=github&logoColor=eceff4&colorA=4c566a&colorB=88c0d0" />
14+
</a>
15+
<a href="https://github.com/nordtheme/java/blob/main/changelog.md" target="_blank">
16+
<img src="https://img.shields.io/github/release/nordtheme/assets.svg?style=flat-square&label=Changelog&logo=github&logoColor=eceff4&colorA=4c566a&colorB=88c0d0" />
17+
</a>
18+
</p>
19+
20+
<p align="center">
21+
Official <a href="https://www.java.com" target="_blank" rel="noreferrer">Java</a> implementation of <a href="https://www.nordtheme.com" target="_blank">Nord</a> — An arctic, north-bluish color palette.
22+
</p>
23+
24+
This repository is currently in a transitioning phase and work in progress!
25+
26+
<p align="center">
27+
<picture>
28+
<source srcset="https://raw.githubusercontent.com/nordtheme/assets/main/static/images/elements/separators/iceberg/footer/dark/spaced.svg?sanitize=true" width="100%" media="(prefers-color-scheme: light), (prefers-color-scheme: no-preference)" />
29+
<source srcset="https://raw.githubusercontent.com/nordtheme/assets/main/static/images/elements/separators/iceberg/footer/light/spaced.svg?sanitize=true" width="100%" media="(prefers-color-scheme: dark)" />
30+
<img src="https://raw.githubusercontent.com/nordtheme/assets/main/static/images/elements/separators/iceberg/footer/dark/spaced.svg?sanitize=true" width="100%" />
31+
</picture>
32+
</p>
33+
34+
<p align="center">
35+
Copyright &copy; 2016-present <a href="https://www.svengreb.de" target="_blank">Sven Greb</a>
36+
</p>
37+
38+
<p align="center">
39+
<a href="https://github.com/nordtheme/java/blob/main/license" target="_blank">
40+
<img src="https://img.shields.io/static/v1.svg?style=flat-square&label=License&message=MIT&logoColor=eceff4&logo=creativecommons&colorA=4c566a&colorB=88c0d0"/>
41+
</a>
42+
<a href="https://www.svengreb.de">
43+
<img src="https://img.shields.io/static/v1.svg?style=flat-square&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QA/wD/AP+gvaeTAAABMklEQVQ4jcWQvUoDQRRGz52s5IfVIiDWPkGKFFaCIVaGdIagjcFAwICFb7DvIK6QQlNpY2UQLMQVBbEQ0SewFkGbKCQmOzaTJay7/lR+zTAf9xwuF/47Mv45rdezqWEq72v/RWZnHgqOMwDwHMfSj085JSqb6Pu38we7r18E3nqzhmYbsE11rxKsAvhDfQiSM30XYbOw57YDwfnaRl6U3ABWaMNn806H+oGPzBX3d+4UgChZiYBHYBgGsBLoKoAyhR0x9G20Zmpc4P1ZoMQDcwMNclFrdhBKv6M5WWi7ZQGtjEUn35IV4OwnVjSX/WGmKqCDDUa5rmyle3bvGFiMg3WGUsF1u0EXHoqTRMGRgkAy2eugKZrqijRLYThWANBpNDL2h3UE0J0YLJdbrfe42f/NJ0wqY7/KcXKPAAAAAElFTkSuQmCC&label=lovely%20crafted%20in&message=Germany&colorA=4c566a&colorB=88c0d0"/>
44+
</a>
45+
</p>

‎LICENSE.md renamed to ‎license

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
MIT License (MIT)
22

3-
Copyright (c) 2016-present Arctic Ice Studio <[email protected]> (http://arcticicestudio.com)
4-
Copyright (c) 2016-present Sven Greb <[email protected]> (http://svengreb.de)
3+
Copyright (c) 2016-present Sven Greb <[email protected]> (https://www.svengreb.de)
54

65
Permission is hereby granted, free of charge, to any person obtaining a copy
76
of this software and associated documentation files (the "Software"), to deal

0 commit comments

Comments
 (0)