X-Git-Url: http://git.meshlink.io/?a=blobdiff_plain;f=README;h=9b3c0eed9b10da8906080a0336f6f99388fe880a;hb=fd437cb61fefdc4abf44813a171c9cf18df695b3;hp=59d992700488cfde49fbc44b79de1413caac37f6;hpb=9d23fe58052b3ef971305699a00ea6dbd1111744;p=meshlink-tiny diff --git a/README b/README index 59d9927..9b3c0ee 100644 --- a/README +++ b/README @@ -1,7 +1,7 @@ -This is the README file for the MeshLink library. Installation instructions may +This is the README file for the MeshLink-tiny library. Installation instructions may be found in the INSTALL file. -MeshLink is Copyright (C) 2014-2018 Guus Sliepen +MeshLink is Copyright (C) 2014-2021 Guus Sliepen This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by @@ -11,22 +11,14 @@ your option) any later version. See the file COPYING for more details. To obtain a license to use this library in commercial software, please contact sales@meshlink.io. - -This is not a finished version ------------------------------- - -Please do not use this library yet. - - -Requirements ------------- - -In order to compile MeshLink, you will need a GNU C compiler environment. - - Features -------- +MeshLink-tiny is a version of the MeshLink library optimized for devices with +very little resources. In particular, it tries to reduce code size and memory +usage, while keeping as much the API and network protocol compatible with the +full MeshLink library as much as possible. + MeshLink is a library that allows applications to connect to other instances of itself, and exchange messages in a secure way. MeshLink provides end-to-end encryption and authentication of messages with perfect forward secrecy. The