booru 2.8.0 → 2.8.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/readme.md +16 -6
package/package.json
CHANGED
package/readme.md
CHANGED
|
@@ -2,13 +2,14 @@
|
|
|
2
2
|
|
|
3
3
|
> _A node package to search boorus_
|
|
4
4
|
|
|
5
|
-
  
|
|
5
|
+
[](https://github.com/AtoraSuunva/booru/actions/workflows/lint-and-test.yml)   
|
|
6
6
|
|
|
7
7
|
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.
|
|
8
8
|
|
|
9
9
|
## Features
|
|
10
10
|
|
|
11
|
-
- Search 15 different boorus (check [sites.json](./src/sites.json))
|
|
11
|
+
- Search posts on 15 different boorus (check [sites.json](./src/sites.json))
|
|
12
|
+
- Search tags on 12 different boorus
|
|
12
13
|
- Normalizes all received data into `Post` objects that are consistent no matter which booru you use
|
|
13
14
|
- Access to the raw data received from the booru as well (transformed from XML to JSON, if applicable)
|
|
14
15
|
- Alias support for boorus (`sb` for `safebooru.org`)
|
|
@@ -16,20 +17,29 @@ Only [non-EoL](https://nodejs.org/en/about/previous-releases) versions of Node.j
|
|
|
16
17
|
- Types (using Typescript)
|
|
17
18
|
- Choose the amount of images to get
|
|
18
19
|
- Random support for all sites, using `order:random` on sites that support it and using custom code on those that don't
|
|
19
|
-
- Coming soon(-ish): Support for more than just searching
|
|
20
20
|
|
|
21
21
|
---
|
|
22
22
|
|
|
23
23
|
## Installation
|
|
24
24
|
|
|
25
|
+
Booru is available on [npm](https://www.npmjs.com/package/booru):
|
|
26
|
+
|
|
25
27
|
```sh
|
|
28
|
+
# Pick your favorite package manager
|
|
26
29
|
npm add booru
|
|
27
|
-
# or
|
|
28
30
|
pnpm add booru
|
|
29
|
-
# or
|
|
30
31
|
yarn add booru
|
|
31
32
|
```
|
|
32
33
|
|
|
34
|
+
And available on [jsr](https://jsr.io/@atorasuunva/booru):
|
|
35
|
+
|
|
36
|
+
```sh
|
|
37
|
+
# Pick your favorite runtime
|
|
38
|
+
pnpm i jsr:@atorasuunva/booru
|
|
39
|
+
deno add jsr:@atorasuunva/booru
|
|
40
|
+
bunx jsr add @atorasuunva/booru
|
|
41
|
+
```
|
|
42
|
+
|
|
33
43
|
---
|
|
34
44
|
|
|
35
45
|
## Usage
|
|
@@ -67,7 +77,7 @@ See [example.js](./example.js) for more examples
|
|
|
67
77
|
|
|
68
78
|
## Docs
|
|
69
79
|
|
|
70
|
-
Available here: [https://booru
|
|
80
|
+
Available here: [https://jsr.io/@atorasuunva/booru/doc](https://jsr.io/@atorasuunva/booru/doc)
|
|
71
81
|
|
|
72
82
|
## Web support
|
|
73
83
|
|