From c6dbeb1fa1f99e684bfac2f5e057ccb04b2af065 Mon Sep 17 00:00:00 2001 From: Logan oos Even <46396513+Logan007@users.noreply.github.com> Date: Wed, 19 Aug 2020 17:52:24 +0545 Subject: [PATCH] updated README.md - hints on stable vs. dev - hint on collection of pre-built Windows binaries --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 9e7edbc..db6754e 100644 --- a/README.md +++ b/README.md @@ -62,6 +62,8 @@ Some parts of the code significantly benefit from compiler optimizations and pla For Windows, MacOS and general building options, please check out [Building.md](doc/Building.md) for compilation and running. +**IMPORTANT** It is generally recommended to use the latest stable release. Please note that the current _dev_ branch usually is not guaranteed to be backward compatible neither with the latest stable release nor with previous _dev_ states. On the other hand, if you do not dare to try the bleeding edge features, you are encouraged to compile from _dev_ – just keep track of sometimes rapidly occuring changes. Feedback in the _Issues_ section is appreciated. + ## Running edge as a Service edge can also be run as a service instead of cli: @@ -99,8 +101,6 @@ IPv6 for edge-to-supernode communication yet. Have a look at [IPv6.md](https://github.com/ntop/n2n/blob/dev/doc/IPv6.md) for more information. - - ## Contribution You can contribute to n2n in various ways: @@ -116,7 +116,8 @@ For details about the internals of n2n check out [Hacking guide](https://github. Here is a list of third-party projects connected to this repository. -- N2N for Android: [hin2n](https://github.com/switch-iot/hin2n) +- Collection of pre-built binaries for Windows: [lucktu](https://github.com/lucktu/n2n) +- n2n for Android: [hin2n](https://github.com/switch-iot/hin2n) - Docker images: [Docker Hub](https://hub.docker.com/r/supermock/supernode/) - Go bindings, management daemons and CLIs for n2n edges and supernodes, Docker, Kubernetes & Helm Charts: [pojntfx/gon2n](https://pojntfx.github.io/gon2n/)