Skip to content

Commit f1fbcb1

Browse files
committed
Update README to remove suggestion to use IRC
Also removes some other cruft.
1 parent d69a2be commit f1fbcb1

File tree

1 file changed

+8
-36
lines changed

1 file changed

+8
-36
lines changed

README.md

Lines changed: 8 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,25 @@
1-
[![Build Status](https://secure.travis-ci.org/danmactough/node-feedparser.png?branch=master)](https://travis-ci.org/danmactough/node-feedparser)
2-
3-
[![NPM](https://nodei.co/npm/feedparser.png?downloads=true&stars=true)](https://nodei.co/npm/feedparser/)
41
# Feedparser - Robust RSS, Atom, and RDF feed parsing in Node.js
52

63
[![Join the chat at https://gitter.im/danmactough/node-feedparser](https://badges.gitter.im/danmactough/node-feedparser.svg)](https://gitter.im/danmactough/node-feedparser?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
74

8-
This module adds methods for RSS, Atom, and RDF feed parsing in node.js using
9-
Isaac Schlueter's [sax](https://github.com/isaacs/sax-js) parser.
5+
[![Build Status](https://secure.travis-ci.org/danmactough/node-feedparser.png?branch=master)](https://travis-ci.org/danmactough/node-feedparser)
6+
7+
[![NPM](https://nodei.co/npm/feedparser.png?downloads=true&stars=true)](https://nodei.co/npm/feedparser/)
8+
9+
Feedparser is for parsing RSS, Atom, and RDF feeds in node.js.
1010

11-
Feedparser has a couple features you don't usually see:
11+
It has a couple features you don't usually see:
1212

1313
1. It resolves relative URLs (such as those seen in Tim Bray's "ongoing" [feed](http://www.tbray.org/ongoing/ongoing.atom)).
1414
2. It properly handles XML namespaces (including those in sadistic feeds
1515
that define a non-default namespace for the main feed elements).
1616

17-
## Requirements
18-
19-
- [sax](https://github.com/isaacs/sax-js)
20-
- [addressparser](https://github.com/andris9/addressparser)
21-
- [array-indexofobject](https://github.com/danmactough/node-array-indexofobject)
22-
- [readable-stream](https://github.com/isaacs/readable-stream)
23-
2417
## Installation
2518

2619
```bash
2720
npm install feedparser
2821
```
2922

30-
## Changes since v0.15.x
31-
32-
- The libxml-like helper methods have been removed. There is now just one input
33-
interface: the stream interface.
34-
35-
- Events:
36-
37-
- `304`, `response` - removed, as Feedparser no longer fetches urls
38-
- `article`, `complete` - removed; use the stream interface
39-
- `data` - all readable streams will emit a `data` event, but this puts the
40-
stream into "old" v0.8-style push streams (if you're using v0.10, but not
41-
v0.12)
42-
- `end` - stream behavior dictates that the `end` event will never fire if
43-
you don't read any data from the stream; you can kick the Feedparser stream
44-
to work like an "old" v0.8-style push stream (and get the old `end` event
45-
behavior) by calling `.resume()`.
46-
47-
- `SAXErrors` are emitted as `error` events. By default, they are automatically
48-
resumed. Pass `{ resume_saxerror: false }` as an option if you want to manually
49-
handle `SAXErrors` (abort parsing, perhaps).
50-
5123
## Usage
5224

5325
The easiest way to use feedparser is to just give it a [readable stream](http://nodejs.org/api/stream.html#stream_readable_stream).
@@ -210,7 +182,7 @@ e.g., `meta['atom:subtitle']['#']`.
210182
## Help
211183

212184
- Don't be afraid to report an [issue](https://github.com/danmactough/node-feedparser/issues).
213-
- You can drop by IRC, too: [#node-feedparser on freenode](http://webchat.freenode.net/?channels=node-feedparser&uio=d4).
185+
- You can drop by [Gitter](https://gitter.im/danmactough/node-feedparser?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge), too.
214186

215187
## Contributors
216188

@@ -223,7 +195,7 @@ the original inspiration and a starting point.
223195

224196
(The MIT License)
225197

226-
Copyright (c) 2011-2015 Dan MacTough and contributors
198+
Copyright (c) 2011-2016 Dan MacTough and contributors
227199

228200
Permission is hereby granted, free of charge, to any person obtaining a copy of
229201
this software and associated documentation files (the 'Software'), to deal in

0 commit comments

Comments
 (0)