# meed

> Get Medium RSS feeds as JSON.

Latest version **1.0.1** (published 2019-05-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install meed
pnpm add meed
yarn add meed
bun add meed
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2019-05-10 |
| First published | 2019-05-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 211.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Paul Esch-Laurent |
| Maintainers | pinjasaur |

## Links

- npm: https://www.npmjs.com/package/meed
- Repository: https://github.com/Pinjasaur/meed
- Homepage: https://meed.js.org/
- npm.io page: https://npm.io/package/meed

## Dependencies (1)

- [rss-parser](https://npm.io/package/rss-parser.md) ^3.7.0

## Recent versions

- 1.0.1 (latest) — 2019-05-10
- 1.0.0 — 2019-05-10
- 1.0.0-beta.1 — 2019-05-05

## README

<h1 align="center">
  <img src="/.github/meed.svg" alt="Meed" width="600">
</h1>

[![Travis](https://img.shields.io/travis/Pinjasaur/meed.svg)](https://travis-ci.org/Pinjasaur/meed)

Modern JS library for getting Medium RSS feeds (user, publcation, topic, or tag)
as JSON. Targets modern browsers / Node.js with an API that utilizes
[`fetch`][fetch] along with [`async` / `await`][async].

Check out the [Meed docs][docs] for details.

## What

Get Medium RSS feeds as JSON. Check out [Ghosts/medium-feed][mf] because it may
suit your needs better.

## Why

Because [@Ghosts](https://github.com/Ghosts) was writing [medium-feed][mf]. ¯\\\_(ツ)_/¯

## How

Medium provides basic docs regarding the RSS feeds: https://help.medium.com/hc/en-us/articles/214874118-RSS-feeds
You can get feeds for a user, publication, topic, or tag. Topics can be found at
https://medium.com/topics or via `Meed#topics()`. In general, feeds seem to be
limited to 10 items.

Check out the [Meed docs][docs] for more.

### Install

Via npm or unpkg:
- `npm install meed` / `yarn add meed`
- https://unpkg.com/meed

### Use

In a browser that supports [`fetch`][ciu-fetch] & [`async`/`await`][ciu-async]:

```js
const feed = new Meed()

;(async () => {
  const user = await feed.user("Medium")
  console.log(user)
})()
```

or in Node.js (bring your own `fetch`):

```js
const Meed  = require("meed")
const fetch = require("node-fetch")

const feed = new Meed({ fetch })

;(async () => {
  const user = await feed.user("Medium")
  console.log(user)
})()
```

### Proxy

For local(host) testing in a browser, you'll probably need a CORS proxy. Here's
a list: https://gist.github.com/jimmywarting/ac1be6ea0297c16c477e17f8fbe51347

You can use one like so:

```js
new Meed({ proxy: "PROXY_URL" })
```

I've had good luck with https://cors-anywhere.herokuapp.com/.

Check out the [Meed docs][docs] for more details.

## Who

[Paul Esch-Laurent](https://github.com/Pinjasaur).

## License

[MIT](https://pinjasaur.mit-license.org/2018).

[mf]: https://github.com/Ghosts/medium-feed
[docs]: https://meed.js.org/

[fetch]: https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API
[async]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/async_function
[ciu-fetch]: https://caniuse.com/#feat=fetch
[ciu-async]: https://caniuse.com/#feat=async-functions

---
_Source: https://npm.io/package/meed · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._