@untidy/animeflv - npm Package Compare versions

Comparing version 0.1.0 to 0.1.1

package.json

 {
   "name": "@untidy/animeflv",
   "description": "web scraping tools for animeflv site",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "type": "module",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
-  "exports": "./dist/index.js",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./url": {
+      "types": "./dist/url.d.ts",
+      "import": "./dist/url.js"
+    },
+    "./cheerio": {
+      "types": "./dist/cheerio.d.ts",
+      "import": "./dist/cheerio.js"
+    },
+    "./package.json": "./package.json"
+  },
   "files": [
@@ -45,2 +59,3 @@ "dist",
   },
+  "homepage": "https://github.com/falsepopsky/lain/blob/main/packages/animeflv/README.md",
   "scripts": {
@@ -47,0 +62,0 @@ "dev": "tsx ./src/playground.ts",

README.md

@@ -5,2 +5,10 @@ # @untidy/animeflv
 
+Web scraping tools for the [animeflv](https://www3.animeflv.net/) site.
+
+> **Warning**  
+> Use of this web scraping package for any malicious or unethical activities is strictly prohibited.
+> By using these tools, you agree to adhere to all applicable laws and regulations, as well as to
+> respect the terms of service of the website you are scraping. The intention of this package is
+> solely for legitimate purposes such as data analysis, research, or personal use.
+
 ## :sparkles: Features
@@ -10,2 +18,6 @@
 - ESM only
+- Uses `cheerio` to retrieve data for paths `browse`, `anime`, `ver` (for both mobile and desktop
+  sites).
+- Utilizes the built-in `URL` module from `node` to create queries in the `browse` path (for both
+  mobile and desktop sites).
 
@@ -34,4 +46,30 @@ ## :package: Install
 
+`@untidy/animeflv` is easy to use, The following example demonstrates how to retrieve the URL for
+recently updated movies in the year 2023.
+
+Example usage:
+
+```typescript
+import { browseFilter } from '@untidy/animeflv';
+
+// If using TypeScript
+import type { Options, OriginURL } from '@untidy/animeflv/url';
+
+const origin: OriginURL = 'https://www3.animeflv.net/';
+const options: Options = {
+  year: '2023',
+  type: 'movie',
+  order: 'updated',
+};
+
+// In this case, the target URL will be: https://www3.animeflv.net/browse?year=2023&type=movie&order=updated
+const target = browseFilter(options, origin);
+```
+
+For more examples with other APIs, please refer to the "Docs" section.
+
 ## :page_facing_up: Docs
 
+Under construction 🚧
+
 ## :scroll: License
@@ -38,0 +76,0 @@

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Fixed alerts

No website

Quality

Package does not have a website.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

26601

increased by11.83%

Number of package files

10

increased by11.11%

Lines of code

273

increased by9.2%

Number of low quality alerts

1

decreased by-50%

Number of lines in readme file

77

increased by97.44%

Worsened metrics

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes