@extractus/feed-extractor - npm Package Compare versions

Comparing version 6.1.5 to 6.1.6

CONTRIBUTING.md

@@ -61,3 +61,3 @@ # Contributing to `@extractus/feed-extractor`
 
-![feed-extractor unit test](https://i.imgur.com/xTwZK6B.png)
+![feed-extractor unit test](https://i.imgur.com/2b5xt6S.png)
 
@@ -64,0 +64,0 @@ If test coverage decreased, please check test scripts and try to improve this number.

dist/cjs/index.d.ts

@@ -59,7 +59,7 @@ // Type definitions
    */
-  extraFeedFields?: (feedData: object) => object;
+  getExtraFeedFields?: (feedData: object) => object;
   /**
    * merge extra entry fields in result
    */
-  extraEntryFields?: (entryData: object) => object;
+  getExtraEntryFields?: (entryData: object) => object;
 }
@@ -66,0 +66,0 @@

dist/cjs/package.json

 {
   "name": "@extractus/feed-extractor",
-  "version": "6.1.5",
+  "version": "6.1.6",
   "main": "./feed-extractor.js"
 }

index.d.ts

@@ -59,7 +59,7 @@ // Type definitions
    */
-  extraFeedFields?: (feedData: object) => object;
+  getExtraFeedFields?: (feedData: object) => object;
   /**
    * merge extra entry fields in result
    */
-  extraEntryFields?: (entryData: object) => object;
+  getExtraEntryFields?: (entryData: object) => object;
 }
@@ -66,0 +66,0 @@

package.json

 {
-  "version": "6.1.5",
+  "version": "6.1.6",
   "name": "@extractus/feed-extractor",
@@ -43,3 +43,3 @@ "description": "To read and normalize RSS/ATOM/JSON feed data",
     "args-parser": "^1.3.0",
-    "esbuild": "^0.15.16",
+    "esbuild": "^0.15.17",
     "jest": "^29.3.1",
@@ -46,0 +46,0 @@ "nock": "^13.2.9",

README.md

@@ -6,17 +6,7 @@ # feed-extractor
 [![npm version](https://badge.fury.io/js/@extractus%2Ffeed-extractor.svg)](https://badge.fury.io/js/@extractus%2Ffeed-extractor)
+![CodeQL](https://github.com/extractus/feed-extractor/workflows/CodeQL/badge.svg)
 ![CI test](https://github.com/extractus/feed-extractor/workflows/ci-test/badge.svg)
 [![Coverage Status](https://img.shields.io/coveralls/github/extractus/feed-extractor)](https://coveralls.io/github/extractus/feed-extractor?branch=main)
-![CodeQL](https://github.com/extractus/feed-extractor/workflows/CodeQL/badge.svg)
 [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
 
-## Intro
-
-*feed-extractor* is a part of tool sets for content builder:
-
-- [feed-extractor](https://github.com/extractus/feed-extractor): extract & normalize RSS/ATOM/JSON feed
-- [article-extractor](https://github.com/extractus/article-extractor): extract main article from given URL
-- [oembed-extractor](https://github.com/extractus/oembed-extractor): extract oEmbed data from supported providers
-
-You can use one or combination of these tools to build news sites, create automated content systems for marketing campaign or gather dataset for NLP projects...
-
 ### Attention
@@ -26,2 +16,3 @@
 
+
 ## Demo
@@ -53,4 +44,8 @@
 
-// or specify exactly path to CommonJS variant
+// you can specify exactly path to CommonJS version
 const { read } = require('@extractus/feed-extractor/dist/cjs/feed-extractor.js')
+
+// extract a RSS
+const result = await read('https://news.google.com/rss')
+console.log(result)
 ```
@@ -76,9 +71,3 @@
 
-### Deta cloud
 
-For [Deta](https://www.deta.sh/) devs please refer [the source code and guideline here](https://github.com/ndaidong/feed-reader-deta) or simply click the button below.
-
-[![Deploy](https://button.deta.dev/1/svg)](https://go.deta.dev/deploy?repo=https://github.com/ndaidong/feed-reader-deta)
-
-
 ## APIs
@@ -227,5 +216,17 @@
 
-Passing requests to proxy is useful while running `@extractus/feed-extractor` on browser. View `examples/browser-feed-reader` as reference example.
+Passing requests to proxy is useful while running `@extractus/feed-extractor` on browser.
+View `examples/browser-feed-reader` as reference example.
 
+## Test
 
+```bash
+git clone https://github.com/extractus/feed-extractor.git
+cd feed-extractor
+npm i
+npm test
+```
+
+![feed-extractor-test.png](https://i.imgur.com/2b5xt6S.png)
+
+
 ## Quick evaluation
@@ -232,0 +233,0 @@

No alert changes

Improved metrics

Number of lines in readme file

241

increased by0.42%

Worsened metrics

Total package byte prevSize

1066238

decreased by-0.05%

No dependency changes