diff --git a/README.asciidoc b/README.asciidoc new file mode 100644 index 000000000..337342b48 --- /dev/null +++ b/README.asciidoc @@ -0,0 +1,26 @@ +// SPDX-FileCopyrightText: 2022 Retroshare Team +// SPDX-FileCopyrightText: 2022 Gioacchino Mazzurco +// SPDX-FileCopyrightText: 2022 Asociación Civil Altermundi +// SPDX-License-Identifier: CC-BY-SA-4.0 + += RetroShare library + +RetroShare is a decentralized, private, secure, cross-platform, communication +software. + +RetroShare functionalities (file sharing, chat, messages, forums, channels...) +are implemented under the hood by libretroshare which offer a documented C++ and +JSON API. + +While RetroShare is an application on it's own, libretroshare is meant to be +used as part of other programs, some of them are +RetroShare-gui[https://retroshare.cc], +RetroShare-service[https://retroshare.cc], +elRepo.io[https://elrepo.io/] mobile application +(let us know if there are more). + + +.Build Status +|=============================================================================== +|Android via JitPack | image:https://jitpack.io/v/com.gitlab.RetroShare/libretroshare.svg[https://jitpack.io/#com.gitlab.RetroShare/libretroshare] +|===============================================================================