From cde0a78d3986ce795bd10bfd9b400ab6ad651578 Mon Sep 17 00:00:00 2001 From: Ethan Lane Date: Mon, 29 Jul 2024 18:10:47 +0100 Subject: [PATCH] Update documentation --- docs/cli.md | 3 ++- readme.md | 1 + 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/cli.md b/docs/cli.md index 774398e..7eb2858 100644 --- a/docs/cli.md +++ b/docs/cli.md @@ -25,6 +25,7 @@ By default, the command will fetch a random image from `r/rabbits` and return it $ random-bunny Archived = false +Author = Rabbit_Owner Downvotes = 0 Hidden = false Permalink = /r/Rabbits/comments/1av1rg9/cute_baby_bun/ @@ -72,7 +73,7 @@ $ random-bunny --json $ randon-bunny -j -{"Archived":false,"Downs":0,"Hidden":false,"Permalink":"/r/Rabbits/comments/1av1rg9/cute_baby_bun/","Subreddit":"Rabbits","SubredditSubscribers":486085,"Title":"Cute baby bun","Ups":210,"Url":"https://i.redd.it/sfz0srdrimjc1.png"} +{"Archived":false,"Author":"Rabbit_Owner","Downs":0,"Hidden":false,"Permalink":"/r/Rabbits/comments/1av1rg9/cute_baby_bun/","Subreddit":"Rabbits","SubredditSubscribers":486085,"Title":"Cute baby bun","Ups":210,"Url":"https://i.redd.it/sfz0srdrimjc1.png"} ``` ## Sort diff --git a/readme.md b/readme.md index 9d9dc9d..e7ba49c 100644 --- a/readme.md +++ b/readme.md @@ -37,6 +37,7 @@ Returns a `json string` for a random post. Accepts 3 arguments: `subreddit`, `so The json string which gets returned consists of: - archived +- author - downs - hidden - permalink