fedifeed/README.md

35 lines
1.2 KiB
Markdown
Raw Normal View History

2017-04-30 18:03:49 +00:00
# Mastofeed
Embed a mastodon feed in your blog et cetera.
2017-05-01 01:12:27 +00:00
https://www.mastofeed.com
2017-04-30 18:26:13 +00:00
2017-04-30 20:07:01 +00:00
## User guide
2017-04-30 18:03:49 +00:00
The homepage has a tool for generating iframe code for you, with a sensible `sandbox` attribute. The feeds fit comfortably in a 400px wide area.
## API
2017-04-30 20:07:01 +00:00
### GET `/api/feed`
2017-04-30 18:03:49 +00:00
2017-04-30 20:07:01 +00:00
> example: `/api/feed?url=https%3A%2F%2Foctodon.social%2Fusers%2Ffenwick67.atom&scale=90&theme=light`
2017-04-30 18:03:49 +00:00
Returns a html page which displays a mastodon feed for an atom feed URL. Note that URLs must be URI encoded (i.e. `encodeURIComponent('https://octodon.social/users/fenwick67.atom')` ).
2017-04-30 20:07:01 +00:00
Querystring options:
2017-04-30 18:03:49 +00:00
2017-04-30 20:07:01 +00:00
| option | required | description |
| ------ | -------- | ----------- |
| `url` | **yes** | Mastodon Atom feed URL |
2017-04-30 20:50:09 +00:00
| `theme` | no | either `dark` or `light`, to select the UI theme (default is `dark`). |
2017-04-30 20:07:01 +00:00
| `size` | no | the scale of the UI in percent. |
## Server Installation
2017-04-30 18:03:49 +00:00
This is a straightforward node project with zero databases or anything, you should just be able to run `npm install` and then `npm start` to get up and running. Set your `PORT` environment variable to change the port it listens on.
## Improve me
Feel free to add a chaching layer, improve the styles and add more features.