| .. | ||
| 00-START-HERE.md | ||
| API.md | ||
| ARCHITECTURE.md | ||
| CLI.md | ||
| DEVELOPMENT.md | ||
| docs.go | ||
| FILES-INDEX.md | ||
| MANIFEST.md | ||
| pool-integration-guide.md | ||
| POOL-RESEARCH-README.md | ||
| pool-research.md | ||
| QUICK-REFERENCE.md | ||
| README.md | ||
| RESEARCH-SUMMARY.txt | ||
| swagger.json | ||
| swagger.yaml | ||
| xmr-pools-database.json | ||
Mining Documentation
Welcome to the documentation for the Mining project. This folder contains detailed information about the API, CLI, architecture, and development processes.
Documentation Index
- API Documentation: Detailed information about the RESTful API endpoints, request/response formats, and Swagger usage.
- CLI Documentation: A comprehensive guide to the Command Line Interface, including command descriptions and usage examples.
- Architecture Guide: An overview of the project's design, including the modular
ManagerInterface, core packages, and data flow. - Development Guide: Instructions for contributors on how to build, test, and release the project.
Quick Start
For a quick start guide, please refer to the main README.md in the project root.