# Enbas

### Overview

Enbas is a [GoToSocial](https://docs.gotosocial.org/en/latest/) client for your terminal written
in [Go](https://go.dev).

The project is in its early stages of development so expect bugs, breaking changes and limited
functionality.
At this time it is not recommended for use this with your production GoToSocial instances.

### Repository mirrors

Enbas is actively developed in [Code Flow](https://codeflow.dananglin.me.uk/apollo/enbas) with
the `main` branch mirrored to the following forges:

- **Codeberg**: https://codeberg.org/dananglin/enbas
- **Radicle**: https://app.radicle.xyz/nodes/seed.radicle.garden/rad:zhqv2orTvTh2x2d7kYky9NhctrpK
- **GitHub**: https://github.com/dananglin/enbas

### Documentation

- **[Installation guide](docs/installation.md)**: A guide for installing Enbas on your machine.
- **[Getting started guide](docs/getting_started.md)**: A guide to help you get started on using Enbas.
- **[Configuration reference](docs/configuration.md)**: The configuration reference documentation.
- **[User manual](docs/manual.md)**: The user manual.
- **[Tips and Tricks](docs/tips_and_tricks.md)**: Additional tips and tricks.

### Licensing

The licensing information associated with each file is specified in the [REUSE.toml](REUSE.toml) file,
but in general:

- All original source code is licensed under GPL-3.0-or-later.
- All documentation is licensed under CC-BY-4.0.

### Inspirations

This project was inspired by the following projects:

* **[madonctl](https://github.com/McKael/madonctl)**: A Mastodon CLI client written in Go.
* **[tut](https://github.com/RasmusLindroth/tut)**: A Mastodon TUI written in Go.
* **[toot](https://pypi.org/project/toot/)**: A Mastodon CLI and TUI written in Python.