booru 2.7.0 → 2.8.1

package/readme.md

@@ -2,13 +2,14 @@
 
 > _A node package to search boorus_
 
-[![CircleCI](https://img.shields.io/circleci/project/github/AtoraSuunva/booru.svg)](https://circleci.com/gh/AtoraSuunva/booru) ![npm](https://img.shields.io/npm/v/booru.svg) ![GitHub](https://img.shields.io/github/license/AtoraSuunva/booru.svg) ![Typescript typings](https://img.shields.io/badge/Typings-Typescript-informational.svg)
+[![Lint and Test](https://github.com/AtoraSuunva/booru/actions/workflows/lint-and-test.yml/badge.svg)](https://github.com/AtoraSuunva/booru/actions/workflows/lint-and-test.yml) ![npm](https://img.shields.io/npm/v/booru.svg) ![GitHub](https://img.shields.io/github/license/AtoraSuunva/booru.svg) ![Typescript typings](https://img.shields.io/badge/Typings-Typescript-informational.svg)
 
-*Minimum supported Node.js version: >=18.17*
+Only [non-EoL](https://nodejs.org/en/about/previous-releases) versions of Node.js are tested and officially supported. EoL versions are unsupported. Other runtimes (like web, Deno, and Bun) aren't _officially_ supported but issues and PRs are accepted for them.
 
 ## Features
 
-- Search 15 different boorus (check [sites.json](./src/sites.json))
+- Search posts on 15 different boorus (check [sites.json](./src/sites.json))
+- Search tags on 12 different boorus
 - Normalizes all received data into `Post` objects that are consistent no matter which booru you use
 - Access to the raw data received from the booru as well (transformed from XML to JSON, if applicable)
 - Alias support for boorus (`sb` for `safebooru.org`)
@@ -16,23 +17,46 @@
 - Types (using Typescript)
 - Choose the amount of images to get
 - Random support for all sites, using `order:random` on sites that support it and using custom code on those that don't
-- Coming soon(-ish): Support for more than just searching
 
 ---
 
 ## Installation
 
+Booru is available on [npm](https://www.npmjs.com/package/booru):
+
 ```sh
+# Pick your favorite package manager
 npm add booru
-# or
+pnpm add booru
 yarn add booru
 ```
 
+And available on [jsr](https://jsr.io/@atorasuunva/booru):
+
+```sh
+# Pick your favorite runtime
+pnpm i jsr:@atorasuunva/booru
+deno add jsr:@atorasuunva/booru
+bunx jsr add @atorasuunva/booru
+```
+
 ---
 
 ## Usage
 
 ```js
+import { search, forSite } from 'booru'
+
+const posts = await search('safebooru', ['glaceon'], {
+  limit: 3,
+})
+
+for (const post of posts) {
+  console.log(post.fileUrl, post.postView)
+}
+
+// Or, using alias support and creating 
+
 const Booru = require('booru')
 
 Booru.search('safebooru', ['glaceon'], { limit: 3, random: true }).then(
@@ -42,9 +66,9 @@ Booru.search('safebooru', ['glaceon'], { limit: 3, random: true }).then(
 )
 
 // or (using alias support and creating boorus)
-const sb = Booru.forSite('sb')
+const sb = forSite('sb')
 
-sb.search(['cat', 'dog'], { limit: 2 })
+const petPosts = await sb.search(['cat', 'dog'], { limit: 2 })
 ```
 
 See [example.js](./example.js) for more examples
@@ -53,7 +77,7 @@ See [example.js](./example.js) for more examples
 
 ## Docs
 
-Available here: [https://booru.js.org](https://booru.js.org)
+Available here: [https://jsr.io/@atorasuunva/booru/doc](https://jsr.io/@atorasuunva/booru/doc)
 
 ## Web support
 
@@ -92,7 +116,7 @@ Derpibooru has `Safe, Suggestive, Questionable, Explicit`, although `Suggestive`
 
 Sure! Just fork this repo, push your changes, and then make a PR.
 
-I'll accept PR based on what they do and code style (Not super strict about it, but it's best if it roughly follows the rest of the code)
+I'll accept PR based on what they do. Make sure your changes pass the lint (`pnpm run lint:fix`) and tests (`pnpm run test`).
 
 ### Why?
 
@@ -129,4 +153,7 @@ Why not?
 
 > [Copy tags argument so it's not modified](https://github.com/AtoraSuunva/booru/pull/103)
 
+[ColonelBologna](https://github.com/ColonelBologna)
+
+> [Tag list](https://github.com/AtoraSuunva/booru/pull/114)
 ---