Skip to content

Commit d40a058

Browse files
committed
docs: Update readme
1 parent dc10b51 commit d40a058

File tree

1 file changed

+18
-15
lines changed

1 file changed

+18
-15
lines changed

README.md

Lines changed: 18 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -15,30 +15,30 @@
1515
[![Api](https://img.shields.io/badge/docs-api-informational.svg)](https://midlevel.github.io/MLAPI/api/)
1616

1717

18-
MLAPI (Mid level API) is a framework that simplifies building networked games in Unity. It offers **low level** access to core networking while at the same time offering **high level** abstractions. The MLAPI aims to remove the repetetive tasks and reduces the network code dramatically, no matter how many of the **modular** features you use.
19-
20-
21-
The MLAPI has features matched by nobody else, any more features are added when requested. The MLAPI is constantly evolving. Read about our features [here](https://mlapi.network/features/).
22-
18+
The Unity MLAPI (Mid level API) is a framework that simplifies building networked games in Unity. It offers **low level** access to core networking while at the same time providing **high level** abstractions. The MLAPI aims to remove the repetetive tasks and reduces the network code dramatically, no matter how many of the **modular** features you use.
2319

2420
### Getting Started
2521
To get started, check the [Wiki](https://mlapi.network/wiki/).
26-
This is also where most documentation lies. Follow the [quickstart](https://mlapi.network/wiki/installation/), join our [discord](http://discord.mlapi.network/) and get started today!
22+
This is also where most documentation lies. Follow the [quickstart](https://mlapi.network/wiki/installation/), join our [Discord](http://discord.mlapi.network/) and get started today!
2723

28-
### Support
29-
For bug reports or feature requests you want to propose, please use the Issue Tracker on GitHub. For general questions, networking advice or to discuss changes before proposing them, please use the [Discord server](https://discord.gg/FM8SE9E).
24+
### Community and Feedback
25+
For general questions, networking advice or discussions about MLAPI, please join our [Discord Community](https://discord.gg/FM8SE9E) or create a post in the [Unity Multiplayer Forum](https://forum.unity.com/forums/multiplayer.26/).
3026

3127
### Compatibility
32-
The MLAPI is built to work everywhere. It will run in the web, on many Unity versions, .NET runtimes and such.
28+
The MLAPI supports all major Unity platforms. To use the WebGL platform a custom WebGL transport based on web sockets is needed.
3329

34-
The requirements for the MLAPI are:
35-
* Unity >= 2017
30+
MLAPI is compatible with Unity 2019 and newer versions.
3631

37-
### Special thanks
38-
Special thanks to [Gabriel Tofvesson](https://github.com/GabrielTofvesson) for writing the BitWriter, BitReader & ECDH implementation.
32+
### Development
33+
We follow the [Gitflow Workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow). The master branch contains our latest stable release version while the develop branch tracks our current work.
34+
35+
### Contributing
36+
The MLAPI is an open-source project and we encourage and welcome
37+
contributions. If you wish to contribute, be sure to review our
38+
[contribution guidelines](CONTRIBUTING.md)
3939

4040
### Issues and missing features
41-
If there are any issues, bugs or features that are missing. Please open an issue on the GitHub [issues page](https://github.com/MidLevel/MLAPI/issues).
41+
If you have an issue, bug or feature request, please follow the information in our [contribution guidelines](CONTRIBUTING.md) to submit an issue.
4242

4343
### Example
4444
Here is a sample MonoBehaviour showing a chat script where everyone can write and read from. This shows the basis of the MLAPI and the abstractions it adds.
@@ -74,4 +74,7 @@ public class Chat : NetworkedBehaviour
7474
}
7575
}
7676
}
77-
```
77+
```
78+
79+
### License
80+
[MIT Licence](LICENSE)

0 commit comments

Comments
 (0)