You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+6-4
Original file line number
Diff line number
Diff line change
@@ -22,13 +22,13 @@
22
22
23
23
## Installation
24
24
25
-
Gymie-client is available as a [NPM package](https://www.npmjs.com/package/gymie), and can installed as a dependency as usual:
25
+
Gymie-Client is available as a [NPM package](https://www.npmjs.com/package/gymie), and can installed as a dependency as usual:
26
26
27
27
```bash
28
28
$ npm install gymie
29
29
```
30
30
31
-
You can also clone the repo and npm-link the library as follow:
31
+
You can also clone the repo and npm-link the library as follows, although there isn't really a good readon to do it this way, unless you wanna contribute to the library and test it locally.
Although there isn't really a good readon to do it this way, unless you wanna contribute to the library and test it locally.
48
+
During the installation [Gymie-Server](https://pypi.org/project/gymie/) will also be installed. It's important to note that Gymie-Server requires Python>=3.6, so I suggest to conda-create an environment with such version if it's not already installed... or upgrade Python to at least this version.
49
49
50
-
## How to run the client
50
+
## How to run the client (and server)
51
+
52
+
Gymie-Client communicates with a server through WebSockets. This server will provide Gymie with an API to access the underlying gym-like API to create and interact with an environment.
0 commit comments