https://github.com/tetherto/mdk

https://github.com/tetherto/mdk

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/tetherto/mdk
• Owner: tetherto
• License: apache-2.0
• Created: 2026-04-27T08:58:31.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2026-05-01T16:09:38.000Z (3 months ago)
• Last Synced: 2026-05-01T18:15:21.271Z (3 months ago)
• Language: TypeScript
• Size: 2.59 MB
• Stars: 0
• Watchers: 0
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS
  • Security: SECURITY.md

Awesome Lists containing this project

README

          
# MDK

[![Status](https://img.shields.io/badge/status-pre--alpha-lightgrey?style=flat-square)](#status)

[![MDK UI CI](https://img.shields.io/github/actions/workflow/status/tetherto/mdk/ui.yaml?branch=main&label=UI%20CI&style=flat-square&logo=github)](https://github.com/tetherto/mdk/actions/workflows/ui.yaml)

[![MDK Core CI](https://img.shields.io/github/actions/workflow/status/tetherto/mdk/core.yaml?branch=main&label=Core%20CI&style=flat-square&logo=github)](https://github.com/tetherto/mdk/actions/workflows/core.yaml)

[![CodeQL](https://github.com/tetherto/mdk/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/tetherto/mdk/actions/workflows/github-code-scanning/codeql)

[![Documentation](https://img.shields.io/badge/docs-mdk.tether.io-2ea44f?style=flat-square)](https://docs.mdk.tether.io)

[This repository](https://github.com/tetherto/mdk) is the monorepo for [MDK](https://mdk.tether.io/), a JavaScript-based SDK that provides a modular and extensible foundation for:

- Monitoring mining infrastructure  

- Controlling devices and containers  

- Collecting telemetry and operational data  

- Building custom mining applications and integrations  

MDK is released under [Apache License Version 2.0](LICENSE).

## Status

⚠️ **Work in Progress**

MDK is currently under active development and is **not yet considered stable**.

The latest development code is available on the `main` branch, with pre-release versions tagged as `*-beta` and `*-rc`. Stable releases will be tagged using semantic versioning without suffixes (e.g., `1.0.0`).

## Current development status

- `*-beta`, `*-rc` → Active development tags (latest features and changes)  

- `x.y.z` → Reserved for stable releases  

To test the SDK or explore the latest functionality, use the **`main` branch**.

## Contributing

Contributions are welcome while MDK is under active development.

### How to contribute

1. Fork this repository.

2. Clone your fork locally.

3. Create a new branch.

4. Make your changes.

5. Submit a Pull Request.

Learn more about [contributing](CONTRIBUTING.md).

For security vulnerability reporting, see the [Security policy](SECURITY.md).

## Documentation

End-user documentation is available at [docs.mdk.tether.io/](https://docs.mdk.tether.io/).

> Request updates to public docs via[`docs-needed` issue](https://github.com/tetherto/mdk/issues/new?template=docs-needed.yml).

Update documentation in this repository directly via the [contribution flow](CONTRIBUTING.md).