This is an automated email from the ASF dual-hosted git repository. toulmean pushed a commit to branch 1.0 in repository https://gitbox.apache.org/repos/asf/incubator-tuweni.git
commit 782c8a036830063b236e04c30e4906f5befd1d9f Author: Antoine Toulme <[email protected]> AuthorDate: Mon Apr 22 15:29:10 2019 -0700 Clean up README ahead of release --- README.md | 72 ++++++++++++++++++++++++++++++++++++++++++++++++++------------- 1 file changed, 57 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 6223257..b5fec7a 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ # Tuweni: Apache Core Libraries for Java (& Kotlin) [](https://builds.apache.org/job/Apache%20Tuweni/job/CI/) -[](https://github.com/ConsenSys/cava/blob/master/LICENSE) -[ ](https://bintray.com/consensys/consensys/cava/0.6.0) - -In the spirit of [Google Guava](https://github.com/google/guava/), Tuweni is a set of libraries and other tools to aid development of blockchain and other decentralized software in Java and other JVM languages. +[](https://github.com/incubator-tuweni/blob/master/LICENSE) +[](https://maven-badges.herokuapp.com/maven-central/org.apache.tuweni/tuweni) +[](https://repository.apache.org/content/repositories/snapshots/org/apache/tuweni/tuweni/) +Tuweni is a set of libraries and other tools to aid development of blockchain and other decentralized software in Java and other JVM languages. It includes a low-level bytes library, serialization and deserialization codecs (e.g. [RLP](https://github.com/ethereum/wiki/wiki/RLP)), various cryptography functions and primatives, and lots of other helpful utilities. @@ -12,9 +12,7 @@ Tuweni is developed for JDK 1.8 or higher, and depends on various other FOSS lib ## Getting tuweni -> Note that these libraries are experimental and are subject to change. - -The libraries are published to [ConsenSys bintray repository](https://consensys.bintray.com/consensys/), synced to JCenter and Maven Central. +The libraries are published to the [Apache Nexus Repository](https://repository.apache.org/), synced to JCenter and Maven Central. You can import all modules using the tuweni jar. @@ -23,14 +21,49 @@ With Maven: <dependency> <groupId>org.apache.tuweni</groupId> <artifactId>tuweni</artifactId> - <version>0.6.0</version> + <version>1.0.0</version> </dependency> ``` -With Gradle: `compile 'org.apache.tuweni:tuweni:0.6.0'` +With Gradle: `compile 'org.apache.tuweni:tuweni:1.0.0'` [PACKAGES.md](PACKAGES.md) contains the list of modules and instructions to import them separately. +### Getting snapshots + +We publish a new snapshot on every change of the master branch. + +Snapshots are stored under the [Apache snapshots repository](https://repository.apache.org/content/repositories/snapshots). + +With Maven, add this repository with: +```xml + <repositories> + <repository> + <id>apache.snapshots</id> + <name>Apache Snapshot Repository</name> + <url>https://repository.apache.org/snapshots</url> + <releases> + <enabled>false</enabled> + </releases> + </repository> + </repositories> +``` + +```xml +<dependency> + <groupId>org.apache.tuweni</groupId> + <artifactId>tuweni</artifactId> + <version>1.0.0-SNAPSHOT</version> +</dependency> +``` + +With gradle: +```groovy +maven { url "https://repository.apache.org/snapshots"} +``` + +`compile 'org.apache.tuweni:tuweni:1.0.0-SNAPSHOT'` + ## Build Instructions To build, clone this repo and run with `./gradlew` like so: @@ -43,11 +76,20 @@ cd incubator-tuweni After a successful build, libraries will be available in `build/libs`. -## Links +## Contributing + +Your contributions are very welcome! Here are a few links to help you: -- [GitHub project](https://github.com/apache/incubator-tuweni) -- [Online Kotlin documentation](https://consensys.github.io/cava/docs/kotlin/0.6.0/cava) -- [Online Java documentation](https://consensys.github.io/cava/docs/java/0.6.0) - [Issue tracker: Report a defect or feature request](https://github.com/apache/incubator-tuweni/issues/new) -- [StackOverflow: Ask "how-to" and "why-didn't-it-work" questions](https://stackoverflow.com/questions/ask?tags=cava+java) -- [cava-discuss: For open-ended questions and discussion](http://groups.google.com/group/cava-discuss) +- [StackOverflow: Ask "how-to" and "why-didn't-it-work" questions](https://stackoverflow.com/questions/ask?tags=tuweni) + +## Mailing lists + +- [[email protected]]([email protected]) is for usage questions, help, and announcements. [subscribe]([email protected]?subject=send%20this%20email%20to%20subscribe), [unsubscribe]([email protected]?subject=send%20this%20email%20to%20unsubscribe), [archives](https://www.mail-archive.com/[email protected]/) +- [[email protected]]([email protected]) is for people who want to contribute code to Tuweni. [subscribe]([email protected]?subject=send%20this%20email%20to%20subscribe), [unsubscribe]([email protected]?subject=send%20this%20email%20to%20unsubscribe), [archives](https://www.mail-archive.com/[email protected]/) +- [[email protected]]([email protected]) is for commit messages and patches to Tuweni. [subscribe]([email protected]?subject=send%20this%20email%20to%20subscribe), [unsubscribe]([email protected]?subject=send%20this%20email%20to%20unsubscribe), [archives](https://www.mail-archive.com/[email protected]/) + +## More information + +- [Official website](https://tuweni.apache.org) +- [GitHub project](https://github.com/apache/incubator-tuweni) --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
