Skip to content

Commit

Permalink
docs: Add note that the README is outdated [no ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
Rover656 committed Sep 30, 2024
1 parent edac4d0 commit 3058052
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Regilite
A lightweight library helping with registration and data generation.

> Note this Usage guide is now outdated. It will be updated at some point, but the best way to get started is to look at the code :)
## Usage
This library provides helper functions and wrappers around for various Holders and registries. To be able to use
Regilite, you firstly create and register a `Regilite`-object. This object will do the actual registring data to events
Expand Down

0 comments on commit 3058052

Please sign in to comment.