Skip to content

Commit 59af400

Browse files
authored
Merge pull request #69 from extractus/review-pr67
Update README
2 parents 43c7330 + a7cb30d commit 59af400

File tree

1 file changed

+7
-12
lines changed

1 file changed

+7
-12
lines changed

README.md

Lines changed: 7 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,25 +3,16 @@
33
To read & normalize RSS/ATOM/JSON feed data.
44

55
[![npm version](https://badge.fury.io/js/@extractus%2Ffeed-extractor.svg)](https://badge.fury.io/js/@extractus%2Ffeed-extractor)
6+
![CodeQL](https://github.com/extractus/feed-extractor/workflows/CodeQL/badge.svg)
67
![CI test](https://github.com/extractus/feed-extractor/workflows/ci-test/badge.svg)
78
[![Coverage Status](https://img.shields.io/coveralls/github/extractus/feed-extractor)](https://coveralls.io/github/extractus/feed-extractor?branch=main)
8-
![CodeQL](https://github.com/extractus/feed-extractor/workflows/CodeQL/badge.svg)
99
[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
1010

11-
## Intro
12-
13-
*feed-extractor* is a part of tool sets for content builder:
14-
15-
- [feed-extractor](https://github.com/extractus/feed-extractor): extract & normalize RSS/ATOM/JSON feed
16-
- [article-extractor](https://github.com/extractus/article-extractor): extract main article from given URL
17-
- [oembed-extractor](https://github.com/extractus/oembed-extractor): extract oEmbed data from supported providers
18-
19-
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...
20-
2111
### Attention
2212

2313
`feed-reader` has been renamed to `@extractus/feed-extractor` since v6.1.4
2414

15+
2516
## Demo
2617

2718
- [Give it a try!](https://extractor-demos.pages.dev/feed-extractor)
@@ -48,8 +39,12 @@ import { read } from '@extractus/feed-extractor'
4839
// CommonJS
4940
const { read } = require('@extractus/feed-extractor')
5041

51-
// or specify exactly path to CommonJS variant
42+
// you can specify exactly path to CommonJS version
5243
const { read } = require('@extractus/feed-extractor/dist/cjs/feed-extractor.js')
44+
45+
// extract a RSS
46+
const result = await read('https://news.google.com/rss')
47+
console.log(result)
5348
```
5449

5550
### Deno

0 commit comments

Comments
 (0)