Skip to content

Commit

Permalink
[ci skip] Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Jo0001 committed Dec 23, 2024
1 parent c0af289 commit 3f77412
Showing 1 changed file with 15 additions and 6 deletions.
21 changes: 15 additions & 6 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,23 @@
# Athena

Log Analysis and more for ViaVersion
Log Analysis and more for the ViaVersion project

**Features**
- Analyze raw logs directly send per POST request
- Analyze logs from [supported sites](https://athena.viaversion.workers.dev/v0/analyze/sites)
- Checks the proxy up2date state (Velocity, Waterfall & BungeeCord)

## API Dokumentation

See development and prod https://www.postman.com/jo0001-team/workspace/viaversion/api/70fb5b15-3f24-4c8c-b633-2d64ac705960

## Contribution

New detections are very welcome - either add them directly per PR or just open an issue :)

## Development
For the development you need [Wrangler](https://developers.cloudflare.com/workers/wrangler/install-and-update/)

To start you local dev server just go to the terminal tab of your IDE and type `npx wrangler dev`

Full commandlist https://developers.cloudflare.com/workers/wrangler/commands/

## API Dokumentation

See development and prod https://www.postman.com/jo0001-team/workspace/viaversion/api/70fb5b15-3f24-4c8c-b633-2d64ac705960
Full commandlist https://developers.cloudflare.com/workers/wrangler/commands/

0 comments on commit 3f77412

Please sign in to comment.