Skip to content

Commit

Permalink
Add Warning to README
Browse files Browse the repository at this point in the history
  • Loading branch information
Brachi authored Nov 9, 2024
1 parent 3b903c8 commit 1b1fe20
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
# Albam

⚠️
Albam is currently in heavy development and may be unstable.
Additionally, documentation is completely lacking except some quick videos and chat histories in discord.
For now, only use it if you really enjoy tinkering or can't wait.
<p align="left">
<a href="https://github.com/Brachi/albam/actions"><img alt="Actions Status" src="https://github.com/Brachi/albam/workflows/Test/badge.svg"></a>
<img alt="Code coverage" src="https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/Brachi/879e4f106f38b080ff10d3f46e3336e6/raw/covbadge.json">
Expand All @@ -7,8 +12,6 @@
This is the source of _Albam_, a [Blender](https://blender.org) [addon](https://docs.blender.org/manual/en/latest/editors/preferences/addons.html) for importing and exporting 3d models and other game engine formats.
Its main purpose is modding, but also education and appreciation of game art.

<img>gif showcase</img>

For user-facing documentation and modding tutorials, refer to the [User Docs]()
For real time communication, join the [Chat](https://discord.gg/69sphky9UX)

Expand Down

0 comments on commit 1b1fe20

Please sign in to comment.