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-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,13 +20,13 @@ WebSocket client that consumes an API wrapping <a href="https://github.com/opena
20
20
21
21
Gymie-Client is available as a [NPM package](https://www.npmjs.com/package/gymie), and can installed as a dependency as usual:
22
22
23
-
```bash
23
+
```
24
24
$ npm install gymie
25
25
```
26
26
27
27
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.
@@ -47,7 +47,7 @@ During the installation [Gymie-Server](https://pypi.org/project/gymie/) will als
47
47
48
48
Gymie-Client communicates with a server through WebSockets. This server will provide Gymie with an API to access the underlying Python library to create and interact with an environment. As mentioned before, this client comes with its [counterpart server](https://github.com/jscriptcoder/Gymie-Server). You can start the server from the command line:
Complete API documentation can be found here: [Gymie-Client API](https://jscriptcoder.github.io/Gymie-Client) (generated by [TypeDoc](http://typedoc.org/))
73
+
Complete API documentation can be found here: [Gymie-Client API](https://jscriptcoder.github.io/Gymie-Client)<sub>(generated by [TypeDoc](http://typedoc.org/))</sub>
74
74
75
75
In the [previous section](#how-to-run-the-client-and-server) we already saw how to import gymie, connect to the server, instantiate an environment and call a few API methods. Let's go a bit more in detail with a complete example of a random agent interacting with an environment:
76
76
@@ -80,8 +80,8 @@ In the [previous section](#how-to-run-the-client-and-server) we already saw how
80
80
81
81
## Testing Gymie
82
82
83
-
Unit-tests live all next to the code they're testing, under the extension `src/*.test.ts`. You can run all the tests by executing:
84
-
```bash
83
+
All unit-tests live next to the code they're testing, under the extension `src/*.test.ts`. You can run all the tests by executing:
0 commit comments