diff --git a/README.md b/README.md index 673f7b2..864a872 100644 --- a/README.md +++ b/README.md @@ -11,9 +11,11 @@ See also: [Invidious, a front-end for YouTube.](https://github.com/omarroth/invi - [x] View profile and timeline - [x] Infinite scroll - [x] User memory cache +- [x] RSS (latest 12 posts) - [ ] Image disk cache - [ ] View post - [ ] Homepage +- [ ] Proper error checking - [ ] Optimised for mobile - [ ] Favicon - [ ] Settings (e.g. data saving) @@ -43,12 +45,19 @@ If you only use one computer, you can install Bibliogram on that computer and th ## Installing -1. `git clone https://github.com/cloudrac3r/bibliogram` -1. `npm install` -1. `npm start` +Bibliogram depends on GraphicsMagick for resizing thumbnails. + +Ubuntu: `# apt install graphicsmagick` + +1. `$ git clone https://github.com/cloudrac3r/bibliogram` +If you are using a fork, be sure to actually install that fork instead! +1. `$ npm install` +1. Edit `/config.js` to suit your server environment +1. `$ npm start` Bibliogram is now running on `0.0.0.0:10407`. ## User-facing endpoints - `/u/{username}` - load a user's profile and timeline +- `/u/{username}/rss.xml` - get the RSS feed for a user