Ethan Lane
8d7624e263
Some checks failed
ci/woodpecker/push/woodpecker Pipeline failed
# Description Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change. - Add to the CLI documentation the mention about the binary releases - Mentioned about the fact you can't use macOS arm64 builds yet due to a bug to be fixed later on #152 ## Type of change Please delete options that are not relevant. - [x] New feature (non-breaking change which adds functionality) # How Has This Been Tested? Please describe the tests that you ran to verify the changes. Provide instructions so we can reproduce. Please also list any relevant details to your test configuration. # Checklist - [ ] My code follows the style guidelines of this project - [ ] I have performed a self-review of my own code - [ ] I have commented my code, particularly in hard-to-understand areas - [ ] I have made corresponding changes to the documentation - [ ] My changes generate no new warnings - [ ] I have added tests that provde my fix is effective or that my feature works - [ ] New and existing unit tests pass locally with my changes - [ ] Any dependent changes have been merged and published in downstream modules Reviewed-on: https://gitea.vylpes.xyz/RabbitLabs/random-bunny/pulls/167 Reviewed-by: VylpesTester <tester@vylpes.com> Co-authored-by: Ethan Lane <ethan@vylpes.com> Co-committed-by: Ethan Lane <ethan@vylpes.com>
69 lines
1.4 KiB
Markdown
69 lines
1.4 KiB
Markdown
# random-bunny
|
|
|
|
> Get a random image url from a subreddit of your choosing.
|
|
|
|
## Install
|
|
|
|
```bash
|
|
npm install --save random-bunny
|
|
```
|
|
|
|
or if you're using yarn
|
|
|
|
```bash
|
|
yarn add random-bunny
|
|
```
|
|
|
|
### Binary
|
|
|
|
The project can be downloaded as a binary for your system via the [GitHub Releases](https://github.com/Vylpes/random-bunny/releases) or [Gitea Releases](https://gitea.vylpes.xyz/RabbitLabs/random-bunny/releases) page.
|
|
|
|
|
|
## Usage
|
|
|
|
```ts
|
|
import randomBunny from "random-bunny";
|
|
|
|
// ... In an async function
|
|
const result = await randomBunny('rabbits', 'hot');
|
|
console.log(result);
|
|
```
|
|
|
|
## API
|
|
|
|
### `randomBunny()`
|
|
|
|
Returns a `json string` for a random post. Accepts 2 arguments: `subreddit`, and `sortby` ('new', 'hot', 'top')
|
|
|
|
The json string which gets returned consists of:
|
|
- archived
|
|
- downs
|
|
- hidden
|
|
- permalink
|
|
- subreddit
|
|
- subredditSubscribers
|
|
- title
|
|
- ups
|
|
- url
|
|
|
|
`sortBy` will default to 'hot' if not given or invalid
|
|
|
|
## CLI
|
|
|
|
Random bunny can also be used as a CLI. This is accessible via the executable (see git releases) or via `src/cli.ts`
|
|
|
|
For more details, see the [documentation](https://docs.vylpes.xyz/books/random-bunny).
|
|
|
|
## Notes
|
|
|
|
* Node 4 or newer.
|
|
* based upon [Random Puppy](https://github.com/dylang/random-puppy)
|
|
|
|
## Links
|
|
|
|
* Discord: [Server Link](https://go.vylpes.xyz/A6HcA)
|
|
* Support: [helpdesk@vylpes.com](mailto:helpdesk@vylpes.com)
|
|
|
|
## License
|
|
|
|
MIT © [Vylpes](https://www.vylpes.com) |