From 11fb3664239dcbf92f484aba95199e14e1926a07 Mon Sep 17 00:00:00 2001 From: Eden Kirin Date: Mon, 27 Mar 2023 14:16:52 +0200 Subject: [PATCH] Update readme files --- javascript/README.md | 21 +++++++++++++++++++++ python/README.md | 35 +++++++++++++++++++++++++++++++++++ 2 files changed, 56 insertions(+) create mode 100644 javascript/README.md diff --git a/javascript/README.md b/javascript/README.md new file mode 100644 index 0000000..f471ef0 --- /dev/null +++ b/javascript/README.md @@ -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 +``` diff --git a/python/README.md b/python/README.md index 73b4c28..a83ca95 100644 --- a/python/README.md +++ b/python/README.md @@ -1 +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 +```