Skip to content

Commit

Permalink
Merge pull request #65 from extractus/6.1.5
Browse files Browse the repository at this point in the history
v6.1.5
  • Loading branch information
ndaidong committed Dec 2, 2022
2 parents 4780906 + 594b7fa commit 223f07e
Show file tree
Hide file tree
Showing 12 changed files with 22 additions and 28 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ If test coverage decreased, please check test scripts and try to improve this nu

## Documentation

If you've changed APIs, please update README and [the examples](https://github.com/extractus/feed-extractor/tree/main/examples).
If you've changed APIs, please update README and [the examples](examples).


## Clean commit histories
Expand All @@ -84,6 +84,6 @@ For people new to git, please refer the following guides:

## License

By contributing to `@extractus/feed-extractor`, you agree that your contributions will be licensed under its [MIT license](https://github.com/extractus/feed-extractor/blob/main/LICENSE).
By contributing to `@extractus/feed-extractor`, you agree that your contributions will be licensed under its [MIT license](LICENSE).

---
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ You can use one or combination of these tools to build news sites, create automa

## Demo

- [Give it a try!](https://demos.pwshub.com/feed-reader)
- [Example FaaS](https://readfeed.deta.dev/?url=https://news.google.com/rss)
- [Give it a try!](https://extractor-demos.pages.dev/feed-extractor)
- [Example FaaS](https://extractus.deno.dev/extract?apikey=rn0wbHos2e73W6ghQf705bdF&type=feed&url=https://news.google.com/rss)

## Install & Usage

Expand Down Expand Up @@ -55,11 +55,11 @@ const { read } = require('@extractus/feed-extractor/dist/cjs/feed-extractor.js')
### Deno

```ts
// deno < 1.28
import { read } from 'https://esm.sh/@extractus/feed-extractor'

// deno > 1.28
import { read } from 'npm:@extractus/feed-extractor'

// deno < 1.28
// import { read } from 'https://esm.sh/@extractus/feed-extractor'
```

### Browser
Expand Down
2 changes: 1 addition & 1 deletion build.js
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ buildSync(cjsVersion)
const cjspkg = {
name: pkg.name,
version: pkg.version,
main: `./${pkg.name}.js`
main: './feed-extractor.js'
}

writeFileSync(
Expand Down
1 change: 0 additions & 1 deletion build.test.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
// release.test

/* eslint-env jest */

import {
Expand Down
2 changes: 1 addition & 1 deletion dist/cjs/feed-extractor.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions dist/cjs/package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "@extractus/feed-extractor",
"version": "6.1.4",
"main": "./@extractus/feed-extractor.js"
"version": "6.1.5",
"main": "./feed-extractor.js"
}
2 changes: 1 addition & 1 deletion dist/feed-extractor.esm.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// @extractus/feed-extractor@6.1.4, by @extractus - built with esbuild at 2022-11-30T07:58:54.236Z - published under MIT license
// @extractus/feed-extractor@6.1.5, by @extractus - built with esbuild at 2022-12-02T14:07:13.301Z - published under MIT license
var __create = Object.create;
var __defProp = Object.defineProperty;
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
Expand Down
6 changes: 3 additions & 3 deletions examples/browser-feed-reader/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# browser-feed-reader

This demo shows how to use feed-reader at client side, with or without proxy.
This demo shows how to use `feed-extractor` at client side, with or without proxy.

To install:

Expand All @@ -18,12 +18,12 @@ npm start

Open `http://localhost:3103/` to test.

Basically `feed-reader` only works at server side.
Basically `feed-extractor` only works at server side.

However there are some noble publishers those enable `Access-Control-Allow-Origin` on their service.
For example with feed resource from [Washington Post](https://feeds.washingtonpost.com/rss/business/technology), [Decrypt](https://decrypt.co/feed) or [FeedBlitz](https://feeds.feedblitz.com/baeldung/cs&x=1) we can read from browser.

Another ideal environment to run `feed-reader` directly is browser extensions.
Another ideal environment to run `feed-extractor` directly is browser extensions.

With the remaining cases, we need a proxy layer to bypass CORS policy.

Expand Down
2 changes: 1 addition & 1 deletion examples/browser-feed-reader/public/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
<div class="row">
<div class="col-12">
<header>
<h1>feed-reader on browser</h1>
<h1>feed-extractor on browser</h1>
</header>
<form id="form_parser">
<fieldset>
Expand Down
7 changes: 4 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"version": "6.1.4",
"version": "6.1.5",
"name": "@extractus/feed-extractor",
"description": "To read and normalize RSS/ATOM/JSON feed data",
"homepage": "https://github.com/extractus/feed-extractor",
Expand All @@ -26,6 +26,7 @@
},
"scripts": {
"lint": "standard .",
"lint:fix": "standard --fix",
"pretest": "npm run lint",
"test": "NODE_ENV=test NODE_OPTIONS=--experimental-vm-modules jest --verbose --coverage=true",
"build": "node build",
Expand All @@ -34,12 +35,12 @@
"dependencies": {
"bellajs": "^11.1.1",
"cross-fetch": "^3.1.5",
"fast-xml-parser": "^4.0.11",
"fast-xml-parser": "^4.0.12",
"html-entities": "^2.3.3"
},
"devDependencies": {
"args-parser": "^1.3.0",
"esbuild": "^0.15.13",
"esbuild": "^0.15.16",
"jest": "^29.3.1",
"nock": "^13.2.9",
"standard": "^17.0.0"
Expand Down
5 changes: 1 addition & 4 deletions reset.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,4 @@
/**
* reset.js
* @ndaidong
**/
// reset.js

import {
existsSync,
Expand Down
5 changes: 1 addition & 4 deletions src/main.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,4 @@
/**
* Feed Reader
* @ndaidong
**/
// main.js

import { isValid as isValidUrl } from './utils/linker.js'

Expand Down

0 comments on commit 223f07e

Please sign in to comment.