Skip to content

Commit 73b104e

Browse files
committed
documentation
1 parent e272108 commit 73b104e

File tree

4 files changed

+15
-5
lines changed

4 files changed

+15
-5
lines changed

.idea/workspace.xml

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

README.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -25,19 +25,23 @@ If you look for features below, you have to use [feedless](https://github.com/da
2525
- GraphQL API
2626
- Plugins
2727

28+
# Changelog
29+
See [here](./changelog.md)
2830

2931
## Quickstart using docker
3032
If you have [docker](https://docs.docker.com/install/) or [podman](https://podman.io/getting-started/installation) installed, do this
3133

3234
```
33-
docker pull damoeb/rss-proxy:2
34-
docker run -p 3000:3000 -e APP_API_GATEWAY_URL=https://foo.bar -it damoeb/rss-proxy
35+
docker pull damoeb/rss-proxy:2.1
36+
docker run -p 3000:3000 -e APP_API_GATEWAY_URL=https://foo.bar -it damoeb/rss-proxy:2.1
3537
```
3638

3739
`APP_API_GATEWAY_URL` is your outfacing url, which will be used as host for feeds you create.
3840

3941
Then open [localhost:8080](http://localhost:8080) in the browser.
4042

43+
# Release Notes for Version 2
44+
-
4145

4246
## Legacy Version 1
4347
If you are interested in running the first prototype, this is how you do it.

changelog.md

+6
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
# Changelog
22

3+
# 2.1.0 - 25.05.2023
4+
- Migrated to [feedless-core-0.1.1](./Dockerfile)
5+
- All endpoints changed from `/api/` to `/api/legacy`
6+
- Maintenance messages can be opted-in by passing `debug=true` in the url
7+
- No tokens are used anymore, just throttling, caching and [host protection](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429)
8+
39
## 2.0.0 - 03.06.2022
410
- Full rewrite in kotlin
511

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11

22
export const build = {
33
version: '2.1.0',
4-
revision: '5eb22d0',
5-
date: '1685087298026'
4+
revision: '909fdd2',
5+
date: '1685087368922'
66
};

0 commit comments

Comments
 (0)