Lomanic/bibliogram
1
0
Fork 0
mirror of https://git.sr.ht/~cadence/bibliogram synced 2024-11-22 16:17:29 +00:00
Code Issues Releases Wiki Activity

Add RSS and graphicsmagick to readme

Browse Source
This commit is contained in:
Cadence Fish 2020-01-15 03:44:45 +13:00
parent 30b45c2573
commit c99de263f4
No known key found for this signature in database
GPG Key ID: 81015DF9AA8607E1
1 changed files with 12 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -11,9 +11,11 @@ See also: [Invidious, a front-end for YouTube.](https://github.com/omarroth/invi
- [x] View profile and timeline - [x] View profile and timeline
- [x] Infinite scroll - [x] Infinite scroll
- [x] User memory cache - [x] User memory cache
- [x] RSS (latest 12 posts)
- [ ] Image disk cache - [ ] Image disk cache
- [ ] View post - [ ] View post
- [ ] Homepage - [ ] Homepage
- [ ] Proper error checking
- [ ] Optimised for mobile - [ ] Optimised for mobile
- [ ] Favicon - [ ] Favicon
- [ ] Settings (e.g. data saving) - [ ] 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 ## Installing
1. `git clone https://github.com/cloudrac3r/bibliogram` Bibliogram depends on GraphicsMagick for resizing thumbnails.
1. `npm install`
1. `npm start` 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`. Bibliogram is now running on `0.0.0.0:10407`.
## User-facing endpoints ## User-facing endpoints
- `/u/{username}` - load a user's profile and timeline - `/u/{username}` - load a user's profile and timeline
- `/u/{username}/rss.xml` - get the RSS feed for a user