# README
GoCryptoTrader package Base
This base package is part of the GoCryptoTrader codebase.
This is still in active development
You can track ideas, planned features and what's in progress on our GoCryptoTrader Kanban board.
Join our slack to discuss all things related to GoCryptoTrader! GoCryptoTrader Slack
Base Communications package
Current Features
- Used to enforce standard variables and methods across the communication packages
Please click GoDocs chevron above to view current GoDoc information for this package
Contribution
Please feel free to submit any pull requests or suggest any desired features to be added.
When submitting a PR, please abide by our coding guidelines:
- Code must adhere to the official Go formatting guidelines (i.e. uses gofmt).
- Code must be documented adhering to the official Go commentary guidelines.
- Code must adhere to our coding style.
- Pull requests need to be based on and opened against the
masterbranch.
Donations
If this framework helped you in any way, or you would like to support the developers working on it, please donate Bitcoin to:
bc1qk0jareu4jytc0cfrhr5wgshsq8282awpavfahc
# Structs
Base enforces standard variables across communication packages.
CommsStatus stores the status of a comms relayer.
CommunicationsConfig holds all the information needed for each enabled communication package.
Event is a generalise event type.
SlackConfig holds all variables to start and run the Slack package.
SMSContact stores the SMS contact info.
SMSGlobalConfig structure holds all the variables you need for instant messaging and broadcast used by SMSGlobal.
SMTPConfig holds all variables to start and run the SMTP package.
TelegramConfig holds all variables to start and run the Telegram package.
# Interfaces
ICommunicate enforces standard functions across communication packages.
# Type aliases
IComm is the main interface array across the communication packages.