Skip to content

Commit a09328b

Browse files
committed
Minor method docs improvement in readme
1 parent 7f578ee commit a09328b

1 file changed

Lines changed: 12 additions & 4 deletions

File tree

Readme.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,9 @@ Here's an example of what an app shows up as on the Plex web interface
3030

3131
The rows in that example from top to bottom are `deviceName`, `version`, `product`, and `device`.
3232

33-
**query(uri) : Retrieve content from URI**
33+
### .query(uri)
34+
35+
**Retrieve content from URI**
3436

3537
Aside from requesting the API and returning its response, an `.uri` property are created to easier follow the URIs available in the HTTP API. At the moment URIs are attached for Directory and Server items.
3638

@@ -51,7 +53,9 @@ client.query("/").then(function (result) {
5153
});
5254
```
5355

54-
**postQuery(uri) : Send a POST request and retrieve the response**
56+
### .postQuery(uri)
57+
58+
**Send a POST request and retrieve the response**
5559

5660
This is identical to ```query(uri)```, except that the request will be a POST rather than a GET.
5761

@@ -73,7 +77,9 @@ client.postQuery("/playQueue?type=video&uri=someuri&shuffle=0'").then(function (
7377
});
7478
```
7579

76-
**perform(uri) : Perform an API action**
80+
### .perform(uri)
81+
82+
**Perform an API action**
7783

7884
When performing an "action" on the HTTP API, the response body will be empty.
7985
As the response content itself is worthless, `perform()` acts on the HTTP status codes the server responds with.
@@ -90,7 +96,9 @@ client.perform("/library/sections/1/refresh").then(function () {
9096
});
9197
```
9298

93-
**find(uri, [{criterias}]) : Find matching child items on URI**
99+
### .find(uri, [{criterias}])
100+
101+
**Find matching child items on URI**
94102

95103
Uses `query()` behind the scenes, giving all directories and servers the beloved `.uri` property.
96104

0 commit comments

Comments
 (0)