Skip to content
This repository was archived by the owner on Oct 20, 2025. It is now read-only.

Commit 93708d6

Browse files
docs(README): update key features and improve license section formatting
1 parent 6e033b5 commit 93708d6

File tree

1 file changed

+24
-13
lines changed

1 file changed

+24
-13
lines changed

README.md

Lines changed: 24 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,14 @@
99
<div align="center">
1010
<p>
1111
<a href="https://github.com/valeriko777/KnoxKit/releases/tag/v1.0.0">
12-
<img src="https://img.shields.io/badge/Version-1.0.0-brightgreen" alt="Version 1.0.0">
13-
</a>
14-
<a href="https://github.com/valeriko777/KnoxKit/issues">
15-
<img src="https://img.shields.io/github/issues/valeriko777/KnoxKit" alt="Issues">
16-
</a>
17-
<a href="https://github.com/valeriko777/KnoxKit/blob/main/LICENSE.md">
18-
<img src="https://img.shields.io/badge/License-Custom%20Apache%202.0-blue" alt="License">
19-
</a>
12+
<img src="https://img.shields.io/badge/Version-1.0.0-brightgreen" alt="Version 1.0.0">
13+
</a>
14+
<a href="https://github.com/valeriko777/KnoxKit/issues">
15+
<img src="https://img.shields.io/github/issues/valeriko777/KnoxKit" alt="Issues">
16+
</a>
17+
<a href="https://github.com/valeriko777/KnoxKit/blob/main/LICENSE.md">
18+
<img src="https://img.shields.io/badge/License-Custom%20Apache%202.0-blue" alt="License">
19+
</a>
2020
</p>
2121
<h3>🚀 Version 1.0.0 Now Available!</h3>
2222
<p>Basic functionality released. More features coming soon!</p>
@@ -25,30 +25,41 @@
2525
[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/nozzdev)
2626

2727
## 🎯 Overview
28+
2829
KnoxKit is a powerful and user-friendly instance manager for Project Zomboid that helps you manage multiple game configurations, mod collections, and system resources efficiently.
2930

3031
## ✨ Key Features
31-
- **Instance Management**: Create, and manage multiple game instances
32-
- **Steam Workshop Integration**: Seamless mod collection synchronization
33-
- **Resource Optimization**: Smart resource allocation per instance
34-
- **Modern UI**: Clean and intuitive interface with dark/light themes
35-
- **Advanced Configuration**: Custom mod profiles and compatibility checks
32+
33+
- **Instance Management**: Create, configure, and launch multiple game instances with ease - each with its own unique settings
34+
- **Mod Collections**: Organize and toggle mods with a visual card-based interface showing preview images and descriptions
35+
- **Steam Workshop Integration**: Import mod collections directly via Steam Workshop URLs or Collection IDs
36+
- **Instance Status Tracking**: Monitor the status of all your game instances at a glance with clear indicators
37+
- **Multiple Instance Profiles**: Maintain separate game setups for different playstyles (e.g., multiplayer with mods, vanilla survival)
38+
- **Download Management**: Track and manage mod downloads with status indicators
39+
- **User-Friendly Interface**: Modern dark/light theme options with intuitive navigation
40+
- **Performance Settings**: Options to minimize KnoxKit to system tray when launching games to optimize resources
41+
- **Multi-language Support**: Choose your preferred language for the application
42+
- **SteamCMD Integration**: Direct connection to Steam's command-line client for reliable workshop content management
3643

3744
## 🛠️ Technical Stack
45+
3846
- **Frontend**: Electron-Vite with React + TypeScript
3947
- **Styling**: Tailwind CSS with Radix UI components
4048
- **State Management**: Nanostores
4149
- **Steam Integration**: SteamCMD (Anonymous access)
4250

4351
## 🔒 Security & Performance
52+
4453
- Instance sandboxing
4554
- Resource usage monitoring
4655
- Automatic performance optimization
4756

4857
## 🤝 Contributing
58+
4959
KnoxKit is in active development. Feel free to submit issues and pull requests.
5060

5161
## 📝 License
62+
5263
Licensed under Apache 2.0 with Commons Clause and Steam Workshop compliance. See [LICENSE.md](LICENSE.md) for details.
5364

5465
---

0 commit comments

Comments
 (0)