Skip to content

Commit 116082d

Browse files
committed
2 parents 4314124 + 9497d27 commit 116082d

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

‎README.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,13 @@ WebSocket client that consumes an API wrapping <a href="https://github.com/opena
2020

2121
Gymie-Client is available as a [NPM package](https://www.npmjs.com/package/gymie), and can installed as a dependency as usual:
2222

23-
```bash
23+
```
2424
$ npm install gymie
2525
```
2626

2727
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.
2828

29-
```bash
29+
```
3030
$ git clone https://github.com/jscriptcoder/Gymie-Client
3131
Cloning into 'Gymie-Client'...
3232
...
@@ -47,7 +47,7 @@ During the installation [Gymie-Server](https://pypi.org/project/gymie/) will als
4747

4848
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:
4949

50-
```bash
50+
```
5151
$ python -m gymie --host 0.0.0.0 --port 5000
5252
(84581) wsgi starting up on http://0.0.0.0:5000
5353
```
@@ -70,7 +70,7 @@ const randomAction = await env.actionSample()
7070

7171
## API and how to use it
7272

73-
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>
7474

7575
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:
7676

@@ -80,8 +80,8 @@ In the [previous section](#how-to-run-the-client-and-server) we already saw how
8080

8181
## Testing Gymie
8282

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:
84+
```
8585
$ npm test
8686
```
8787

0 commit comments

Comments
(0)