Add README for libretroshare

This commit is contained in:
Gioacchino Mazzurco 2022-01-17 18:46:42 +01:00
parent f42b389ce3
commit f45f70415f
No known key found for this signature in database
GPG Key ID: A1FBCA3872E87051

26
README.asciidoc Normal file
View File

@ -0,0 +1,26 @@
// SPDX-FileCopyrightText: 2022 Retroshare Team <contact@retroshare.cc>
// SPDX-FileCopyrightText: 2022 Gioacchino Mazzurco <gio@retroshare.cc>
// SPDX-FileCopyrightText: 2022 Asociación Civil Altermundi <info@altermundi.net>
// 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]
|===============================================================================