Compare commits

..

3 Commits

Author SHA1 Message Date
10290dba54 Update main readme 2023-03-27 14:20:34 +02:00
11fb366423 Update readme files 2023-03-27 14:16:52 +02:00
818617ddd4 Python SDK readme 2023-03-27 14:09:36 +02:00
3 changed files with 61 additions and 0 deletions

4
README.md Normal file
View File

@ -0,0 +1,4 @@
# FairHopper SDK for Python and JavaScript
- [Python](python/README.md)
- [JavaScript](javascript/README.md)

21
javascript/README.md Normal file
View File

@ -0,0 +1,21 @@
# FairHopper JavaScript SDK
Requirements:
- Node 1.16+
## Running demo
Check `demo.js` for usage example.
Edit `demo.js` and configure FairHopper Game host settings:
```javascript
const FAIRHOPPER_HOST = "http://127.0.0.1";
const FAIRHOPPER_PORT = 8010;
```
Run example using node:
```sh
node demo.js
```

36
python/README.md Normal file
View File

@ -0,0 +1,36 @@
# FairHopper Python SDK
Requirements:
- Python 3.10+
## Setting up environment
Project uses [Poetry](https://python-poetry.org), ultimate dependency management software for Python.
Install Poetry:
```sh
pip install poetry
```
Install virtual environment:
```sh
poetry install
```
## Running demo
Check `demo.py` for usage example.
Edit `demo.py` and configure FairHopper Game host settings:
```python
FAIRHOPPER_HOST = "http://127.0.0.1"
FAIRHOPPER_PORT = 8010
```
Activate environment and run example:
```sh
poetry shell
python demo.py
```