From a43ac0689b6e5adb4e4b490925b8ac439c8957f8 Mon Sep 17 00:00:00 2001 From: Igor Artamonov Date: Wed, 26 Feb 2020 00:22:28 -0500 Subject: [PATCH] update readme with details for dependency config --- LICENSE.txt => LICENSE | 0 README.adoc | 89 ++++++++++++++++++++++++++++++++++++++++++ README.md | 21 ---------- build.gradle | 2 +- 4 files changed, 90 insertions(+), 22 deletions(-) rename LICENSE.txt => LICENSE (100%) create mode 100644 README.adoc delete mode 100644 README.md diff --git a/LICENSE.txt b/LICENSE similarity index 100% rename from LICENSE.txt rename to LICENSE diff --git a/README.adoc b/README.adoc new file mode 100644 index 0000000..e6d137f --- /dev/null +++ b/README.adoc @@ -0,0 +1,89 @@ += Noise Protocol for Java + +image:https://api.bintray.com/packages/emerald/noise-java/noise/images/download.svg["Bintray", link="https://bintray.com/emerald/noise-java/noise/"] +image:https://img.shields.io/github/license/emeraldpay/noise-java.svg?maxAge=2592000["License", link="https://github.com/emeraldpay/noise-java/blob/master/LICENSE"] + +Java Library that offers the features in the base Noise spec. It doesn't implement Noise Pipes, NoiseLingoSocket or +other newer extensions. + +== Original Work + +This library is a fork of https://github.com/rweather/noise-java[Rhys Weatherley's Noise-Java library] and +https://github.com/corda/noise-java[Mike Hearn], who modernized it to benefit from newer Java versions. + +Differences from the https://github.com/rweather/noise-java[Rhys Weatherley's Noise-Java library] upstream project include: + +* Uses Gradle for the build and JavaDocs. +* Fully modular when used on Java 9+ (has a module-info descriptor) +* Crypto fallbacks have been removed. This version can only use the JDK's native AES/GCM support. This is because + for users on modern Java the native AES/GCM support is better: it's hardware accelerated using + AES-NI, and removing emulations and fallback logic makes the library smaller and easier to + review. The small size and easy auditability of Noise protocols is one of their primary benefits. +* Updated to more modern Java language constructs (still targets Java 8 runtimes), and fixed various + static analysis warnings. Fleshed out a few JavaDocs. +* Added the test vectors from Noise-C and made them run by default as part of `gradle test`. + +As a consequence of these changes, this version may be unsuitable for pre-Lollipop Android versions. +The original might be better if you need to support those cases. + +The main difference from https://github.com/corda/noise-java[Mike Hearn] is that current fork is accessible +through a public repository on Bintray. + +== Usage + +=== Dependency + +.Gradle +---- +repositories { + jcenter() + maven { url "https://dl.bintray.com/emerald/noise-java" } +} + +dependencies { + compile 'io.emeraldpay.noise:noise:1.0' +} +---- + +.Maven +---- + + + bintray-emerald-noise-java + bintray + https://dl.bintray.com/emerald/noise-java + false + + + + + io.emeraldpay.noise + noise + 1.0 + pom + +---- + +== License + +MIT License + +Copyright (C) 2016 Southern Storm Software, Pty Ltd. + +Permission is hereby granted, free of charge, to any person obtaining a +copy of this software and associated documentation files (the "Software"), +to deal in the Software without restriction, including without limitation +the rights to use, copy, modify, merge, publish, distribute, sublicense, +and/or sell copies of the Software, and to permit persons to whom the +Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included +in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS +OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +DEALINGS IN THE SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md deleted file mode 100644 index 949dab1..0000000 --- a/README.md +++ /dev/null @@ -1,21 +0,0 @@ -Noise Protocol for Java -======================= - -This library is a fork of [Rhys Weatherley's Noise-Java library](https://github.com/rweather/noise-java), but -modernised to benefit from newer Java versions. As such it offers the features in the base Noise spec. It doesn't -implement Noise Pipes, NoiseLingoSocket or other newer extensions. - -Differences from the upstream project include: - -* Uses Gradle for the build and JavaDocs. -* Fully modular when used on Java 9+ (has a module-info descriptor) -* Crypto fallbacks have been removed. This version can only use the JDK's native AES/GCM support. This is because - for users on modern Java the native AES/GCM support is better: it's hardware accelerated using - AES-NI, and removing emulations and fallback logic makes the library smaller and easier to - review. The small size and easy auditability of Noise protocols is one of their primary benefits. -* Updated to more modern Java language constructs (still targets Java 8 runtimes), and fixed various - static analysis warnings. Fleshed out a few JavaDocs. -* Added the test vectors from Noise-C and made them run by default as part of `gradle test`. - -As a consequence of these changes, this version may be unsuitable for pre-Lollipop Android versions. -The original might be better if you need to support those cases. \ No newline at end of file diff --git a/build.gradle b/build.gradle index bf2149e..e62211a 100644 --- a/build.gradle +++ b/build.gradle @@ -114,7 +114,7 @@ bintray { userOrg = 'emerald' repo = 'noise-java' name = project.name - licenses = ['Apache-2.0'] + licenses = ['MIT'] vcsUrl = 'https://github.com/emeraldpay/noise-java.git' labels = ['noise', 'protocol', 'cryptography'] publicDownloadNumbers = true