This is an automated email from the ASF dual-hosted git repository. humbedooh pushed a commit to branch main in repository https://gitbox.apache.org/repos/asf/incubator-tuweni-website.git
commit 95be540be02ff8a756ac48136d237fb59a72fa91 Author: Antoine Toulme <[email protected]> AuthorDate: Sun Jan 3 00:27:51 2021 -0800 Refactor docs into folders --- index.md | 6 ++++ tutorials/apps/index.md | 14 +++++++++ tutorials/index.md | 14 ++------- tutorials/{ => libraries}/creating-bytes.md | 0 tutorials/{ => libraries}/creating-uints.md | 0 tutorials/{ => libraries}/extracting-values.md | 0 .../{ => libraries}/getting-started-with-bytes.md | 0 .../{ => libraries}/getting-started-with-units.md | 0 tutorials/{ => libraries}/index.md | 6 ++-- tutorials/{ => libraries}/manipulating-bytes.md | 0 tutorials/{ => libraries}/mutable-bytes.md | 0 tutorials/{ => libraries}/own-bytes-class.md | 0 tutorials/{ => libraries}/own-uints-class.md | 0 tutorials/{ => libraries}/uints-operations.md | 0 .../networking/getting-started-with-discovery.md | 6 ++++ tutorials/networking/getting-started-with-net.md | 6 ++++ .../networking/getting-started-with-plumtree.md | 6 ++++ tutorials/networking/getting-started-with-rlpx.md | 6 ++++ tutorials/networking/index.md | 36 ++++++++++++++++++++++ 19 files changed, 86 insertions(+), 14 deletions(-) diff --git a/index.md b/index.md index bb39b25..93a9b9c 100644 --- a/index.md +++ b/index.md @@ -26,3 +26,9 @@ limitations under the License. {% include themes/apache/logo.html %} Apache 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), various cryptography functions and primitives, and lots of other helpful utilities. + +To learn how to use Apache Tuweni for low-level libraries, such as bytes, bigints, RLP encoding and so on, [follow this tutorial](/tutorials/libraries). + +To learn more about the networking libraries Apache Tuweni supports, [follow along here](/tutorials/networking). + +To start using the applications bundled with Apache Tuweni, [click here](/tutorials/apps). \ No newline at end of file diff --git a/tutorials/apps/index.md b/tutorials/apps/index.md new file mode 100644 index 0000000..c2fc50a --- /dev/null +++ b/tutorials/apps/index.md @@ -0,0 +1,14 @@ +--- +layout: tutorial +title: Applications +description: Applications +group: nav-right +--- + +TODO ! + +gossip +hobbits-relayer +eth-client-app +devp2p +eth-faucet \ No newline at end of file diff --git a/tutorials/index.md b/tutorials/index.md index 360def7..1e614ad 100644 --- a/tutorials/index.md +++ b/tutorials/index.md @@ -5,16 +5,8 @@ description: Tutorials group: nav-right --- -# All about bytes +To learn how to use Apache Tuweni for low-level libraries, such as bytes, bigints, RLP encoding and so on, [follow this tutorial](/tutorials/libraries). -In this tutorial, we explain in detail how to use the bytes library of Apache Tuweni. +To learn more about the networking libraries Apache Tuweni supports, [follow along here](/tutorials/networking). -## [Start tutorial](getting-started-with-bytes) - -# Big integers and Ethereum domain objects - -Unsigned ints - uints - are interesting domain objects to perform arithmetic operations with blockchains. - -We explain in detail how to use the units library of Apache Tuweni. - -## [Start tutorial](getting-started-with-units) \ No newline at end of file +To start using the applications bundled with Apache Tuweni, [click here](/tutorials/apps). \ No newline at end of file diff --git a/tutorials/creating-bytes.md b/tutorials/libraries/creating-bytes.md similarity index 100% rename from tutorials/creating-bytes.md rename to tutorials/libraries/creating-bytes.md diff --git a/tutorials/creating-uints.md b/tutorials/libraries/creating-uints.md similarity index 100% rename from tutorials/creating-uints.md rename to tutorials/libraries/creating-uints.md diff --git a/tutorials/extracting-values.md b/tutorials/libraries/extracting-values.md similarity index 100% rename from tutorials/extracting-values.md rename to tutorials/libraries/extracting-values.md diff --git a/tutorials/getting-started-with-bytes.md b/tutorials/libraries/getting-started-with-bytes.md similarity index 100% rename from tutorials/getting-started-with-bytes.md rename to tutorials/libraries/getting-started-with-bytes.md diff --git a/tutorials/getting-started-with-units.md b/tutorials/libraries/getting-started-with-units.md similarity index 100% rename from tutorials/getting-started-with-units.md rename to tutorials/libraries/getting-started-with-units.md diff --git a/tutorials/index.md b/tutorials/libraries/index.md similarity index 79% copy from tutorials/index.md copy to tutorials/libraries/index.md index 360def7..7a3e9da 100644 --- a/tutorials/index.md +++ b/tutorials/libraries/index.md @@ -1,7 +1,7 @@ --- layout: tutorial -title: Tutorials -description: Tutorials +title: Libraries Tutorials +description: Libraries Tutorials group: nav-right --- @@ -17,4 +17,4 @@ Unsigned ints - uints - are interesting domain objects to perform arithmetic ope We explain in detail how to use the units library of Apache Tuweni. -## [Start tutorial](getting-started-with-units) \ No newline at end of file +## [Start tutorial](getting-started-with-units) diff --git a/tutorials/manipulating-bytes.md b/tutorials/libraries/manipulating-bytes.md similarity index 100% rename from tutorials/manipulating-bytes.md rename to tutorials/libraries/manipulating-bytes.md diff --git a/tutorials/mutable-bytes.md b/tutorials/libraries/mutable-bytes.md similarity index 100% rename from tutorials/mutable-bytes.md rename to tutorials/libraries/mutable-bytes.md diff --git a/tutorials/own-bytes-class.md b/tutorials/libraries/own-bytes-class.md similarity index 100% rename from tutorials/own-bytes-class.md rename to tutorials/libraries/own-bytes-class.md diff --git a/tutorials/own-uints-class.md b/tutorials/libraries/own-uints-class.md similarity index 100% rename from tutorials/own-uints-class.md rename to tutorials/libraries/own-uints-class.md diff --git a/tutorials/uints-operations.md b/tutorials/libraries/uints-operations.md similarity index 100% rename from tutorials/uints-operations.md rename to tutorials/libraries/uints-operations.md diff --git a/tutorials/networking/getting-started-with-discovery.md b/tutorials/networking/getting-started-with-discovery.md new file mode 100644 index 0000000..57b1e9a --- /dev/null +++ b/tutorials/networking/getting-started-with-discovery.md @@ -0,0 +1,6 @@ +--- +layout: tutorial +title: Getting Started With Discovery +description: Getting Started With Discovery +group: nav-right +--- \ No newline at end of file diff --git a/tutorials/networking/getting-started-with-net.md b/tutorials/networking/getting-started-with-net.md new file mode 100644 index 0000000..9b38c0e --- /dev/null +++ b/tutorials/networking/getting-started-with-net.md @@ -0,0 +1,6 @@ +--- +layout: tutorial +title: Getting Started With TLS +description: Getting Started With TLS +group: nav-right +--- \ No newline at end of file diff --git a/tutorials/networking/getting-started-with-plumtree.md b/tutorials/networking/getting-started-with-plumtree.md new file mode 100644 index 0000000..95dbcdb --- /dev/null +++ b/tutorials/networking/getting-started-with-plumtree.md @@ -0,0 +1,6 @@ +--- +layout: tutorial +title: Getting Started With Plumtree +description: Getting Started With Plumtree +group: nav-right +--- \ No newline at end of file diff --git a/tutorials/networking/getting-started-with-rlpx.md b/tutorials/networking/getting-started-with-rlpx.md new file mode 100644 index 0000000..b163f39 --- /dev/null +++ b/tutorials/networking/getting-started-with-rlpx.md @@ -0,0 +1,6 @@ +--- +layout: tutorial +title: Getting Started With RLPx +description: Getting Started With RLPx +group: nav-right +--- \ No newline at end of file diff --git a/tutorials/networking/index.md b/tutorials/networking/index.md new file mode 100644 index 0000000..b398540 --- /dev/null +++ b/tutorials/networking/index.md @@ -0,0 +1,36 @@ +--- +layout: tutorial +title: Networking +description: Networking +group: nav-right +--- + +# TLS communications for peer-to-peer applications + +In this tutorial, we show how you can configure direct communications with other peers. + +## [Start tutorial](getting-started-with-net) + +# RLPx networking + +Ethereum Devp2p wire protocol relies on RLPx to encrypt messages between peers. + +In this tutorial, we show how you can use a RLPx server and create your own subprotocols. + +## [Start tutorial](getting-started-with-rlpx) + +# Devp2p Discovery + +Ethereum relies on discovery mechanisms to find new peers. + +Discv4 is used by Ethereum clients, while Discv5 is used by Ethereum2 clients. + +## [Start tutorial](getting-started-with-discovery) + +# Plumtree + +The Plumtree library is an implementation of [Epidemic Broadcast Trees](http://citeseerx.ist.psu.edu/viewdoc/download?doi=10.1.1.190.3504&rep=rep1&type=pdf). + +In this tutorial, we will show you how to create your very own gossip application, and take a look at our example of the `gossip` application. + +## [Start tutorial](getting-started-with-plumtree) --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
