Skip to content

Commit a12eb54

Browse files
authored
Update README.md
1 parent 84e67fc commit a12eb54

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

README.md

+6-4
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,13 @@
2222

2323
## Installation
2424

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:
2626

2727
```bash
2828
$ npm install gymie
2929
```
3030

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.
3232

3333
```bash
3434
$ git clone https://github.com/jscriptcoder/Gymie-Client
@@ -45,9 +45,11 @@ $ npm link gymie
4545
/path/to/project/node_modules/gymie -> /usr/local/lib/node_modules/gymie -> /path/to/Gymie-Client
4646
```
4747

48-
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.
4949

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.
5153

5254
## API and how to use it
5355

0 commit comments

Comments
 (0)