njfox / space_trader

Space Trader API Golang Wrapper

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Cover Image

πŸš€ Space Trader API πŸ› οΈ [WIP]

Build Status codecov Go Report Card

Space Traders is an API game where players explore the stars in order to exploit for it's riches.

More info available here.

This project provides a golang wrapper for the api.

πŸ› οΈ Work In Progress

Notice this package is in it's alpha stage and is subject to api changes.

πŸ”§ Documentation

πŸ’Ύ Models

Most of the objects have been modelled and can be accessed through the model package.

The methods in this wrapper return the relevant model.

πŸ“” Examples

πŸ’» Contribution

This project is open to contributions.

To contribute follow the standard go style as much as possible and try to achieve an 80% code coverage or higher, with unit tests for the code submitted / changed.

Contributors will be acknowledge in this readme.

❀️ Contributors

  • HOWZ1T - Project Author & Maintainer
  • Trescenzi - Added Functionality & Fixed Documentation Typo

βš–οΈ License

This project is licensed under GNU General Public License v3.0.

πŸ“ TODO

  • More Examples
    • Quick Start
  • Continuous Integration
  • Unit Tests (Reach at least 80% coverage)
  • Documentation
  • Event System
  • Events:
    • Low Fuel
    • Out Of Fuel
    • Low Cargo Space
    • Cargo Full
    • Low Credits
    • Out Of Credits
    • Loan Due

About

Space Trader API Golang Wrapper

License:GNU General Public License v3.0


Languages

Language:Go 100.0%