Skip to content
This repository has been archived by the owner on Sep 21, 2022. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
intenscia authored Oct 15, 2020
1 parent 61616be commit 2610514
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
<a href="https://mod.io"><img src="https://static.mod.io/v1/images/branding/modio-color-dark.svg" alt="mod.io" width="360" align="right"/></a>
# mod.io SDK
[![License](https://img.shields.io/badge/license-MIT-brightgreen.svg)](https://github.com/modio/modio-SDK/blob/master/LICENSE)
[![License](https://img.shields.io/badge/license-MIT-brightgreen.svg)](https://github.com/modio/modio-sdk/blob/master/LICENSE)
[![Discord](https://img.shields.io/discord/389039439487434752.svg?label=Discord&logo=discord&color=7289DA&labelColor=2C2F33)](https://discord.mod.io)
[![Master docs](https://img.shields.io/badge/docs-master-green.svg)](https://github.com/modio/modio-SDK/wiki)
[![GitHub Action](https://github.com/modio/SDK/workflows/ci/badge.svg)](https://github.com/modio/modio-SDK/actions)
[![Master docs](https://img.shields.io/badge/docs-master-green.svg)](https://github.com/modio/modio-sdk/wiki)
[![GitHub Action](https://github.com/modio/modio-sdk/workflows/ci/badge.svg)](https://github.com/modio/modio-sdk/actions)

Welcome to the mod.io SDK repository, built using C and C++. It allows game developers to host and automatically install user-created mods in their games. It connects to the [mod.io API](https://docs.mod.io), and [documentation for its functions](https://github.com/modio/modio-SDK/wiki) can be viewed here.
Welcome to the mod.io SDK repository, built using C and C++. It allows game developers to host and automatically install user-created mods in their games. It connects to the [mod.io API](https://docs.mod.io), and [documentation for its functions](https://github.com/modio/modio-sdk/wiki) can be viewed here.

## Features

Expand Down Expand Up @@ -213,12 +213,12 @@ modio_instance.setUploadListener([&](u32 response_code, u32 mod_id) {

### Feature rich integration

Visit the [wiki](https://github.com/modio/modio-SDK/wiki) to learn how to integrate dependencies, comments, stats, reports and more.
Visit the [wiki](https://github.com/modio/modio-sdk/wiki) to learn how to integrate dependencies, comments, stats, reports and more.

## Getting started

If you are a game developer, first step is to add mod support to your game. Once mod support is up and running, [create your games profile](https://mod.io/games/add) on mod.io, to get an API key and access to all [functionality mod.io offers](https://mod.io/blog/getting-started).
Next, download the latest [SDK release](https://github.com/modio/modio-SDK/releases) and unpack it into your project, then head over to the [GitHub Wiki](https://github.com/modio/modio-SDK/wiki/Getting-Started) and follow the guides corresponding to your setup.
Next, download the latest [SDK release](https://github.com/modio/modio-sdk/releases) and unpack it into your project, then head over to the [GitHub Wiki](https://github.com/modio/modio-sdk/wiki/Getting-Started) and follow the guides corresponding to your setup.

```c++
#include "modio.h"
Expand Down Expand Up @@ -250,7 +250,7 @@ Are you creating a wrapper? [Let us know](http://discord.mod.io)!
### Building instructions
Learn how to build mod.io SDK in our [building instruction guide](https://github.com/modio/modio-SDK/wiki/Building).
Learn how to build mod.io SDK in our [building instruction guide](https://github.com/modio/modio-sdk/wiki/Building).
### Code contributions
Expand All @@ -265,7 +265,7 @@ git push origin my-new-feature

### Reporting a bug

If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/modio/modio-SDK/issues). Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.
If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/modio/modio-sdk/issues). Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

## Other Repositories
Our aim with [mod.io](https://mod.io), is to provide an [open modding API](https://docs.mod.io). You are welcome to [view, fork and contribute to our other codebases](https://github.com/modio) in use.

0 comments on commit 2610514

Please sign in to comment.