Skip to content

typo fix / add inline codeblocks #16

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
cozyplanes wants to merge 1 commit into
base: master
Choose a base branch
from
Open

typo fix / add inline codeblocks #16

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 16 additions & 15 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
```javascript
npm install rantscript
```

### Examples

#### Console logging the 10 top posts on devRant:
Expand All @@ -22,7 +23,7 @@ devRant
})
```

#### Enableing debug mode and compression:
#### Enabling debug mode and compression:

```javascript
var devRant = require('rantscript');
Expand Down Expand Up @@ -59,22 +60,22 @@ devRant
##

### All Functions
| Function | Usage | Description |
| ------------ | ------------------------------------------------- | ------------------------- |
| .rants | .rants('sort', limit, skip, token) | Load rants. |
| .rant | .rant(rant_id) | Load a single rant by id. |
| .search | .search('search term') | Search on devRant |
| .profile | .profile('Username') | Load a profile by name |
| .login | .login('Username','Password') | Get a devRant auth token |
| .postRant | .postRant('Rant', 'Tags', token) | Post a rant to devRant |
| .postComment | .postComment('Comment', rant_id, token) | Post a comment to a rant |
| .vote | .vote(<0 = down & 1 = up>, rant_id, token) | Vote on a rant |
| .voteComment | .voteComment(<0 = down & 1 = up>, rant_id, token) | Vote on a comment |
| .httpSettings| See Bellow | Change settings for the http requests|
| Function | Usage | Description |
| ------------ | --------------------------------------------------- | ------------------------------------- |
| .rants | `.rants('sort', limit, skip, token)` | Load rants |
| .rant | `.rant(rant_id)` | Load a single rant by id |
| .search | `.search('search term')` | Search on devRant |
| .profile | `.profile('Username')` | Load a profile by name |
| .login | `.login('Username','Password')` | Get a devRant auth token |
| .postRant | `.postRant('Rant', 'Tags', token)` | Post a rant to devRant |
| .postComment | `.postComment('Comment', rant_id, token)` | Post a comment to a rant |
| .vote | `.vote(<0 = down & 1 = up>, rant_id, token)` | Vote on a rant |
| .voteComment | `.voteComment(<0 = down & 1 = up>, rant_id, token)` | Vote on a comment |
| .httpSettings| See Below | Change settings for the http requests |

### All Settings
| Function | Usage |
| ------------ | ----------------------------------------------------- |
| Function | Description |
| ----------------------------- | ------------------------------------ |
| .GET_DEBUG() | Returns the current Debug state. |
| .SET_DEBUG(true or false) | Enable or disable console.log |
| .GET_COMPRESS() | Returns the current Compress state. |
Expand Down