add: README.md

This commit is contained in:
lily 2025-03-28 03:02:17 -04:00
parent d94188a7ac
commit 7a90ae9cb1
Signed by: lily
GPG key ID: 601F3263FBCBC4B9

21
README.md Normal file
View file

@ -0,0 +1,21 @@
<div align="center">
<h1 style="margin-bottom: 0;">Kosmora 📂</h1>
<p style="font-weight: bold">A Virtual File System for Game Assets</p>
<img src="https://img.shields.io/badge/rust-%23000000.svg?style=for-the-badge&logo=rust&logoColor=white" alt="Rust"/>
<img src="https://img.shields.io/badge/NIX-5277C3.svg?style=for-the-badge&logo=NixOS&logoColor=white" alt="Nix"/><br>
<img src="https://pride-badges.pony.workers.dev/static/v1?label=Queerware&labelColor=%23000&stripeWidth=5&stripeColors=E40303%2CFF8C00%2CFFED00%2C008026%2C24408E%2C732982" alt="Queerware">
</div>
---
Kosmora provides a virtualized file system for game assets to be stored within, allowing for improved performance, more efficent memory usage, and a smaller storage footprint.
---
## Documentation
TBW
## Simple Example
TBW