Skip to content

Commit

Permalink
lol i fucked up documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
JesseStorms committed Feb 14, 2021
1 parent 87ac621 commit 0514e9c
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 9 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,21 +13,21 @@ Why did I make this? I was really bored and searched for excuses to learn how to
const yourmama = require('yourmama')

//get a random joke
const randomJoke = yourmama.getRoast() //Omitting params returns a random roast.
const randomJoke = yourmama.getRandom()
const randomJoke = yourmama.getRoast().then(roast=>{return roast}) //Omitting params returns a random roast.
const randomJoke = yourmama.getRandom().then(roast=>{return roast})

//get a random joke in a topic
//topic can be: fat, short, stupid, ugly, nasty, hairy, bald, old, poor, skinny, tall and nice
const fatJoke = yourmama.getTopic({topic:'fat'}) //if object only contains topic.
const fatJoke = yourmama.getTopic("fat")
const fatJoke = yourmama.getRoast({topic:'fat'}).then(roast=>{return roast}) //if object only contains topic.
const fatJoke = yourmama.getTopic("fat").then(roast=>{return roast})
//get by ID, just makes a giant array and selects one of them
const speficiJoke = yourmama.getRoast({id:0})
const specificJoke = yourmama.getID(0)
const speficiJoke = yourmama.getRoast({id:0}).then(roast=>{return roast})
const specificJoke = yourmama.getID(0).then(roast=>{return roast})
//returns "Yo mama is so fat that her bellybutton gets home 15 minutes before she does."
//get a specific one out of the topic array
const firstFatJoke = yourmama.getRoast({topic:'fat',id:0}) //returns "Yo mama is so fat that her bellybutton gets home 15 minutes before she does."
const firstFatJoke = yourmama.getRoast({topic:'fat',id:0}).then(roast=>{return roast}) //returns "Yo mama is so fat that her bellybutton gets home 15 minutes before she does."

## Contributing

Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
{
"name": "yourmama",
"version": "1.0.2",
"version": "1.0.3",
"description": "recieve random yomama jokes",
"main": "index.js",
"scripts": {
"test": "mocha"
},
"keywords": [
"yomama"
"yomama","yourmama","meme","shitpost"
],
"author": "JesseStorms",
"license": "MIT",
Expand Down

0 comments on commit 0514e9c

Please sign in to comment.