cosmetic changes to readme.md

This commit is contained in:
Piotr Marzec
2019-05-27 17:41:28 +02:00
parent f2d4127a31
commit a3ca815975

View File

@@ -1,8 +1,10 @@
# Galaxy python plugin API
# GOG Galaxy - Community Integration - Python API
## Usage
This document is still work in progress.
Implement plugin:
## Basic Usage
Basic implementation:
```python
import asyncio
@@ -15,10 +17,10 @@ class PluginExample(Plugin):
# run plugin event loop
if __name__ == "__main__":
asyncio.run(MockPlugin().run())
asyncio.run(PluginExample().run())
```
Use [pyinstaller](https://www.pyinstaller.org/) to create plugin executbale.
Use [pyinstaller](https://www.pyinstaller.org/) to create plugin executable.
## Development
@@ -31,15 +33,15 @@ Run tests:
```bash
pytest
```
## Methods Documentation
TODO
## Changelog
### 0.21
* Add `Epic` platform.
### 0.16
* Do not log sensitive data.
* Return `LocalGameState` as int (possible combination of flags).
### 0.15
* `shutdown()` is called on socket disconnection.
### 0.14
* Added required version parameter to Plugin constructor.
* Added required version parameter to Plugin constructor.