Skip to content
This repository was archived by the owner on Jul 16, 2020. It is now read-only.

Commit 5e81b32

Browse files
committed
doc: Update the readme to reflect new API changes.
1 parent a111417 commit 5e81b32

File tree

1 file changed

+8
-9
lines changed

1 file changed

+8
-9
lines changed

README.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,7 @@
1-
# New SDK!
2-
3-
We are currently rewriting this C++ SDK so that it is easier to integrate and build into your game project. If you are building on Win32, Xbox, and/or UWP please check out our new source in our v2 branch [here](https://github.com/mixer/interactive-cpp/tree/v2).
4-
Android and iOS support will be coming soon.
5-
61
# Mixer Interactivity C++ SDK
72

83
The C++ Interactivity SDK supports client-side development with Mixer Interactivity.
9-
If you have not read through our [Interactive Reference Documentation](https://dev.mixer.com/reference/interactive/) now is a great time to do that.
4+
If you have not read through our [Interactive Reference Documentation](https://dev.mixer.com/reference/interactive/) now is a great time to do that.
105

116
## Quick Start
127

@@ -18,7 +13,7 @@ $ git clone https://github.com/mixer/interactive-cpp.git interactive-cpp
1813

1914
Copy the `source` directory into your C++ game project (you will likely want to rename it). Add `interactivity.cpp` to your compilation list and include `interactivity.h` to get started.
2015

21-
See the [InteractiveSample](https://github.com/mixer/interactive-cpp/tree/v2/samples/InteractiveSample) for an example of how you might handle authorization and connect to an interactive session.
16+
See the [InteractiveSample](https://github.com/mixer/interactive-cpp/tree/master/samples/InteractiveSample) for an example of how you might handle authorization and connect to an interactive session.
2217

2318
### Authorization
2419
If you don't plan on handling authorization yourself you can use the provided authorization helper functions. To do so you will need an OAuth client ID which you can obtain here: https://mixer.com/lab/oauth
@@ -28,7 +23,7 @@ This source code was designed to be easily consumed by any game project. Some of
2823
* A single header and [unity build](https://en.wikipedia.org/wiki/Single_Compilation_Unit) style cpp file.
2924
* An extern "C" interface.
3025
* No dependencies exposed in the header, all usage of STL and other libraries are quarantined from your game.
31-
* Callbacks for easy memory management and managed language interop.
26+
* Callbacks on the caller's thread for easy memory management and managed language interop.
3227
* All interactive functions assume UTF-8 strings for input and output parameters.
3328

3429
## Release Notes
@@ -44,7 +39,11 @@ library? Let us know and we'd love to work with you. For a good starting point o
4439
we are headed and feature ideas, take a look at our [requested features and bugs](https://github.com/mixer/interactive-cpp/issues) or [backlog](https://github.com/mixer/interactive-cpp/blob/master/backlog.md).
4540

4641
Big or small we'd like to take your contributions to help improve the Mixer Interactivity
47-
API for everyone.
42+
API for everyone.
43+
44+
## Legacy SDK
45+
46+
If you are looking for the previous version of the SDK it is preserved [here](https://github.com/mixer/interactive-cpp/tree/legacy).
4847

4948
## Having Trouble?
5049

0 commit comments

Comments
 (0)