Files
Reticulum-Go/README.md
Ivan f4a929ce3a
Some checks failed
Go Build Multi-Platform / build (amd64, windows) (push) Failing after 41s
Go Build Multi-Platform / build (amd64, freebsd) (push) Failing after 46s
Go Build Multi-Platform / build (amd64, linux) (push) Failing after 44s
Go Build Multi-Platform / build (arm, freebsd) (push) Failing after 33s
Go Build Multi-Platform / build (arm, linux) (push) Failing after 33s
Go Build Multi-Platform / build (arm, windows) (push) Failing after 32s
Go Build Multi-Platform / build (arm64, freebsd) (push) Failing after 55s
Go Build Multi-Platform / build (arm64, linux) (push) Failing after 53s
Go Test Multi-Platform / Test (ubuntu-latest, arm64) (push) Successful in 43s
Run Gosec / tests (push) Successful in 58s
Go Build Multi-Platform / build (amd64, darwin) (push) Failing after 48s
Go Build Multi-Platform / build (arm64, darwin) (push) Failing after 35s
Go Build Multi-Platform / build (arm64, windows) (push) Failing after 51s
Go Test Multi-Platform / Test (ubuntu-latest, amd64) (push) Successful in 1m29s
Go Build Multi-Platform / Create Release (push) Has been skipped
Go Revive Lint / lint (push) Successful in 45s
Go Test Multi-Platform / Test (macos-latest, amd64) (push) Has been cancelled
Go Test Multi-Platform / Test (windows-latest, amd64) (push) Has been cancelled
Go Test Multi-Platform / Test (macos-latest, arm64) (push) Has been cancelled
Update README.md
2025-11-13 10:30:50 -06:00

68 lines
1.8 KiB
Markdown

[![Socket Badge](https://socket.dev/api/badge/go/package/github.com/sudo-ivan/reticulum-go?version=v0.4.0)](https://socket.dev/go/package/github.com/sudo-ivan/reticulum-go)
![Multi-Platform Tests](https://github.com/Sudo-Ivan/Reticulum-Go/actions/workflows/go-test.yml/badge.svg)
![Gosec Scan](https://github.com/Sudo-Ivan/Reticulum-Go/actions/workflows/gosec.yml/badge.svg)
[![Multi-Platform Build](https://github.com/Sudo-Ivan/Reticulum-Go/actions/workflows/build.yml/badge.svg)](https://github.com/Sudo-Ivan/Reticulum-Go/actions/workflows/build.yml)
[![Revive Linter](https://github.com/Sudo-Ivan/Reticulum-Go/actions/workflows/revive.yml/badge.svg)](https://github.com/Sudo-Ivan/Reticulum-Go/actions/workflows/revive.yml)
# Reticulum-Go
A Go implementation of the [Reticulum Network Protocol](https://github.com/markqvist/Reticulum).
> [!WARNING]
> This project is currently in development and is not yet compatible with the Python reference implementation.
## Goals
- To be fully compatible with the Python reference implementation.
- Additional privacy and security features.
- Support for a broader range of platforms and architectures legacy and modern.
## Quick Start
### Prerequisites
- Go 1.24 or later
### Build
```bash
make build
```
### Run
```bash
make run
```
### Test
```bash
make test
```
## Embedded systems and WebAssembly
For building for WebAssembly and embedded systems, see the [tinygo branch](https://github.com/Sudo-Ivan/Reticulum-Go/tree/tinygo). Requires TinyGo 0.37.0+.
```bash
make tinygo-build
make tinygo-wasm
```
### Experimental Features
Build with experimental Green Tea GC (Go 1.25+):
```bash
make build-experimental
```
## Official Channels
- [Telegram](https://t.me/reticulum_go)
- [Matrix](https://matrix.to/#/#reticulum-go-dev:matrix.org)
## Donations
See [donate.md](donate.md) for more information.