booru 2.7.0 → 2.8.0

package/readme.md

@@ -2,9 +2,9 @@
 
 > _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)
+![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
 
@@ -25,6 +25,8 @@
 ```sh
 npm add booru
 # or
+pnpm add booru
+# or
 yarn add booru
 ```
 
@@ -33,6 +35,18 @@ yarn add 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 +56,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
@@ -92,7 +106,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 +143,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)
 ---