Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
Signed-off-by: Eiko Wagenknecht <[email protected]>
  • Loading branch information
eikowagenknecht committed Feb 7, 2025
1 parent 2f4af3f commit d5f4839
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 8 deletions.
13 changes: 5 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,14 @@ You like getting games for free, but you *don't* like having to keep track of th
Also your F5 key starts to look a bit worn out?
Then this is for you!

## Version 2.0
## Current status

In version 2.0, the project has been completely rewritten.
It now uses TypeScript instead of Python.
If you want to migrate from the old version to the new one, you can keep the old database.
But you need to create a new configuration file as it's format and options have changed significantly.
Version 2.0 of this project is about to be released.

The new version runs a lot faster (10min instead of 22min when I compared a complete run over all scrapers), smaller (900MB Docker image instead of 1.8GB) and should be more reliable.
But there may still be some bugs, so please report them if you find any.
Currently (February 2025) the stable instance is still running on version 1.14.3 and the development instance is running on version 2.0.2.
The next public release will then be version 2.0.x, once the development instance has been running stable for a while.

You can find the old Python version in the `legacy` branch.
But even after that, there may still be some bugs, so please report them if you find any.

## Public feeds / channels / bots

Expand Down
13 changes: 13 additions & 0 deletions README_DEV.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,19 @@ At all.
The commands below are for Windows and use `pnpm`.
If you use Linux or other packet managers, you probably know the right substitutes.

## Version 2.0

In February 2025, I released version 2.0 of this project.
It is a complete rewrite and uses TypeScript instead of Python.
The new version runs a lot faster (10min instead of 22min when I compared a complete run over all scrapers), smaller (900MB Docker image instead of 1.8GB) and should be more reliable.

If you want to migrate from the old version (1.x) to the new one (2.x):

- Keep the old database. It will be automatically migrated.
- Create a new configuration file as its format and options have changed significantly.

You can find the old Python version in the `legacy-python` branch and the new one in `main`.

## Run this locally

To run this yourself, you first need an installed Node.js 22+ environment.
Expand Down

0 comments on commit d5f4839

Please sign in to comment.