Merge pull request #7 from DBolical/master

Readme updates from man repo

.travis.yml

@@ -19,20 +19,3 @@ script:
   - if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then cmake . ; fi
   - cmake --build . -- -j2
   - ls
-
-before_deploy:
-  # Set up git user name and tag this commit
-  - git config --local user.name "${GH_USER}"
-  - git config --local user.email "${GH_EMAIL}"
-  - if [[ "$TRAVIS_OS_NAME" != "osx" ]]; then git tag "Linux-$(date +'%Y%m%d%H%M%S')" ; fi
-  - if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then git tag "OSX-$(date +'%Y%m%d%H%M%S')" ; fi
-  - if [[ "$TRAVIS_OS_NAME" != "osx" ]]; then zip release.zip libmodio.so ; fi
-  - if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then zip release.zip libmodio.dylib ; fi
-
-deploy:
-  provider: releases
-  api_key: "${GH_TOKEN}"
-  file: "release.zip"
-  skip_cleanup: true
-  on:
-    branch: master

README.md

@@ -1,13 +1,29 @@
+<a href="https://mod.io"><img src="https://static.mod.io/v1/images/branding/modio-color-dark.svg" alt="mod.io" width="400"/></a>
+
 # mod.io SDK
-Welcome to [mod.io](https://mod.io) SDK, built using 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 endpoints](https://github.com/DBolical/modioSDK/wiki) can be viewed here.
+[![License](https://img.shields.io/badge/license-MIT-brightgreen.svg)](https://github.com/DBolical/modioSDK/blob/master/LICENSE)
+[![Discord](https://img.shields.io/discord/389039439487434752.svg)](https://discord.mod.io)
+[![Master docs](https://img.shields.io/badge/docs-master-green.svg)](https://github.com/DBolical/modioSDK/wiki)
+
+
+Welcome to the [mod.io SDK](https://apps.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/DBolical/modioSDK/wiki) can be viewed here.
 
 ## Getting started
 
-If you are a game developer and want to add mod.io SDK functionality to your project visit our [getting started guide](https://github.com/DBolical/modioSDK/wiki).
+If you are a game developer and want to add mod.io SDK functionality to your project visit our [documentation overview](https://github.com/DBolical/modioSDK/wiki). Our [getting started guide](https://apps.mod.io/guides/getting-started) is a good place to start if you are completely new to [mod.io](https://mod.io).
 
 ## Contributions Welcome
 Our SDK is public and open source. Game developers are welcome to utilize it directly, to add support for mods in their games, or fork it to create plugins and wrappers for other engines and codebases. Many of these [contributions are shared](https://apps.mod.io) here. Want to make changes to our SDK? Submit a pull request with your recommended changes to be reviewed.
 
+## Wrappers
+
+mod.io SDK wrappers are available for the following languages and engines:
+
+* [Haxe wrapper](https://apps.mod.io/haxe-wrapper) for game engines such as OpenFL, Kha or awe5. Available on [Github](https://github.com/Turupawn/modioHaxe).
+* [Unreal Engine](https://apps.mod.io/unreal-engine-plugin) integration tutorial and plugin on the works.
+
+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/DBolical/modioSDK/wiki/Building).

examples/sample-projects/Readme.md

@@ -1,3 +1,3 @@
 # Sample projects
 
-This directory contains a variety of sample projects showing the minimal configuration required to setup mod.io on different platforms. In every directory you will find a guide that shows how to setup, compile and run the projects and a `Makefile` showing the configuration needed. If you want a more detailed explanation please follow our [Getting Started](https://github.com/DBolical/modioSDK/wiki/Getting-Started) documentation.
+This directory contains a variety of sample projects helping you achieve the minimal configuration required to setup mod.io on different platforms. In every directory you will find a `Readme.md` file that assists you to setup, compile and run the projects and a `Makefile` showing the configuration needed. If you want a more detailed explanation please follow our [Getting Started](https://github.com/DBolical/modioSDK/wiki/Getting-Started) documentation.

examples/sample-projects/linux-gcc/Readme.md

@@ -1,4 +1,4 @@
-This project shows the minimal setup required to add the mod.io functionality to your project using the GNU C++ compiler. The `Makefile` in this directory shows how to include the mod.io headers and link the `libmodio.so` library. The `libmodio.so` is not present by default, we recomend you to grab it from our [releases page](https://github.com/DBolical/modioSDK/releases) and adjust the `MODIO_LIB_DIR` on the `Makefile` but you can also build it yourself by [following our guide](https://github.com/DBolical/modioSDK/wiki/Building).
+This project contains the minimal setup required to add the mod.io functionality to your game using the GNU C++ compiler. The `Makefile` in this directory shows how to include the mod.io headers and link the `libmodio.so` library. The `libmodio.so` is not present by default, we recomend you to grab it from our [releases page](https://github.com/DBolical/modioSDK/releases) and adjust the `MODIO_LIB_DIR` on the `Makefile` but you can also build it yourself by [following our guide](https://github.com/DBolical/modioSDK/wiki/Building).
 
 # Setting up your compiler
 
@@ -11,7 +11,6 @@ $ sudo apt install g++
 $ sudo yum install gcc-c++
 ```
 
-
 # Compile and run your project
 
 Open a terminal, go to this project directory and run the `Makefile` by using the `make` command:
@@ -20,8 +19,10 @@ Open a terminal, go to this project directory and run the `Makefile` by using th
 $ make
 ```
 
-Once the `MyProject` binary file is generated you can execute it by typing:
+The `MyProject` binary should be generated, you can execute it by typing:
 
 ```bash
 $ ./MyProject
 ```
+
+You can find a detailed explanation on how to setup mod.io in the [Getting Started](https://github.com/DBolical/modioSDK/wiki/Getting-Started) guide. Once you finished setting up mod.io on your project you can complete your integration by following our [documentation](https://github.com/DBolical/modioSDK/wiki).

examples/sample-projects/macos-clang/Readme.md

@@ -1,4 +1,4 @@
-This project shows the minimal setup required to add the mod.io functionality to your project using the Clang compiler on Mac OS. The `Makefile` in this directory shows how to include the mod.io headers and link the `libmodio.dylib` library. The `libmodio.dylib` is not present by default, we recomend you to grab it from our [releases page](https://github.com/DBolical/modioSDK/releases) and adjust the `MODIO_LIB_DIR` on the `Makefile` but you can also build it yourself by [following our guide](https://github.com/DBolical/modioSDK/wiki/Building).
+This project contains the minimal setup required to add the mod.io functionality to your game using the Clang compiler on Mac OS. The `Makefile` in this directory shows how to include the mod.io headers and link the `libmodio.dylib` library. The `libmodio.dylib` is not present by default, we recomend you to grab it from our [releases page](https://github.com/DBolical/modioSDK/releases) and adjust the `MODIO_LIB_DIR` on the `Makefile` but you can also build it yourself by [following our guide](https://github.com/DBolical/modioSDK/wiki/Building).
 
 # Setting up your compiler
 
@@ -12,8 +12,10 @@ Open a terminal, go to this project directory and run the `Makefile` by using th
 $ make
 ```
 
-Once the `MyProject` binary file is generated you can execute it by typing:
+The `MyProject` binary should be generated, you can execute it by typing:
 
 ```bash
 $ ./MyProject
 ```
+
+You can find a detailed explanation on how to setup mod.io in the [Getting Started](https://github.com/DBolical/modioSDK/wiki/Getting-Started) guide. Once you finished setting up mod.io on your project you can complete your integration by following our [documentation](https://github.com/DBolical/modioSDK/wiki).

examples/sample-projects/windows-mingw/Readme.md

@@ -1,4 +1,4 @@
-This project shows the minimal setup required to add the mod.io functionality to your project using the MinGW compiler on Windows. The `Makefile` in this directory shows how to include the mod.io headers and link the `libmodio.dll.a` library. The `libmodio.dll.a` is not present by default, we recomend you to grab it from our [releases page](https://github.com/DBolical/modioSDK/releases) and adjust the `MODIO_LIB_DIR` on the `Makefile` but you can also build it yourself by [following our guide](https://github.com/DBolical/modioSDK/wiki/Building).
+This project contains the minimal setup required to add the mod.io functionality to your game using the MinGW compiler on Windows. The `Makefile` in this directory shows how to include the mod.io headers and link the `libmodio.dll.a` library. The `libmodio.dll.a` is not present by default, we recomend you to grab it from our [releases page](https://github.com/DBolical/modioSDK/releases) and adjust the `MODIO_LIB_DIR` on the `Makefile` but you can also build it yourself by [following our guide](https://github.com/DBolical/modioSDK/wiki/Building).
 
 # Setting up your compiler
 
@@ -16,8 +16,10 @@ Open a terminal, go to this project directory and run the `Makefile` by using th
 > mingw32-make
 ```
 
-Once the `MyProject.exe` binary file is generated add the `libmodio.dll` next to it and execute by typing:
+The `main.exe` binary should be generated, now add the `libmodio.dll` next to it and execute by typing:
 
 ```bash
 > main.exe
 ```
+
+You can find a detailed explanation on how to setup mod.io in the [Getting Started](https://github.com/DBolical/modioSDK/wiki/Getting-Started) guide. Once you finished setting up mod.io on your project you can complete your integration by following our [documentation](https://github.com/DBolical/modioSDK/wiki).

examples/sample-projects/windows-nmake/Readme.md

@@ -1,4 +1,4 @@
-This project shows the minimal setup required to add the mod.io functionality to your project using the Visual Studio's NMake compiler on Windows. The `Makefile` in this directory shows how to include the mod.io headers and link the `modio.lib` library. The `modio.lib` is not present by default, we recomend you to grab it from our [releases page](https://github.com/DBolical/modioSDK/releases) and adjust the `MODIO_LIB_DIR` on the `Makefile` but you can also build it yourself by [following our guide](https://github.com/DBolical/modioSDK/wiki/Building).
+This project contains the minimal setup required to add the mod.io functionality to your game using the Visual Studio's NMake compiler on Windows. The `Makefile` in this directory shows how to include the mod.io headers and link the `modio.lib` library. The `modio.lib` is not present by default, we recomend you to grab it from our [releases page](https://github.com/DBolical/modioSDK/releases) and adjust the `MODIO_LIB_DIR` on the `Makefile` but you can also build it yourself by [following our guide](https://github.com/DBolical/modioSDK/wiki/Building).
 
 # Setting up your compiler
 
@@ -16,8 +16,10 @@ Open a terminal, go to this project directory and run the `Makefile` by using th
 > nmake
 ```
 
-Once the `MyProject.exe` binary file is generated add the `modio.dll` next to it and execute by typing:
+The `main.exe` binary should be generated, now add the `modio.dll` next to it and execute by typing:
 
 ```bash
 > main.exe
 ```
+
+You can find a detailed explanation on how to setup mod.io in the [Getting Started](https://github.com/DBolical/modioSDK/wiki/Getting-Started) guide. Once you finished setting up mod.io on your project you can complete your integration by following our [documentation](https://github.com/DBolical/modioSDK/wiki).

lib/Readme.md

@@ -1,6 +1,6 @@
 This directory contains the mod.io dependencies needed to build mod.io for Windows. If you want to integrate mod.io into your game please refer to the [mod.io SDK overview](https://github.com/DBolical/modioSDK/wiki), you don't need to build mod.io in order to use it on your game you can use our [binary release](https://github.com/DBolical/modioSDK/releases) instead.
 
-mod.io uses Curl and Zlib as external libraries. Both are present on Mac OS by default and can be downloaded from the most common repositories on [Linux](https://github.com/DBolical/modioSDK/wiki/Building#linux). We ship Windows version of both libraries under this directory so you can build mod.io right away using our [Building guide](https://github.com/DBolical/modioSDK/wiki/Building#linux). The following is a guide to build Curl and Zlib from source using both VisualC++ and MinGW compilers.
+mod.io uses Curl and Zlib as external libraries. Both are present on Mac OS by default and can be downloaded from the most common repositories on [Linux](https://github.com/DBolical/modioSDK/wiki/Building#linux). We ship Windows version of both libraries under this directory so you can build mod.io right away using our [Building guide](https://github.com/DBolical/modioSDK/wiki/Building). The following is a guide to build Curl and Zlib from source using both VisualC++ and MinGW compilers.
 
 # Zlib