Skip to content

Commit e377a8a

Browse files
authored
Enhance README with project overview and features
Added sections explaining the purpose and functionality of Hymod, along with its target audience.
1 parent cc6e864 commit e377a8a

1 file changed

Lines changed: 18 additions & 6 deletions

File tree

README.md

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,26 @@
11
# Hymod
22

3-
📊 [**Development Progress**](https://hydmg.github.io/hymod/)
3+
<img width="411" height="136" alt="hymodlogosmall" src="https://github.com/user-attachments/assets/f3c34442-f480-45c0-84ba-01d33b7bda17" />
44

55
View hymod Development Progress:
66
- **Test Dashboard** - All tests with pass/fail status (main page)
7+
- 📊 [**Development Progress**](https://hydmg.github.io/hymod/)
8+
9+
## Why Hymod
10+
11+
Hymod is a command-line toolkit for Hytale mod developers who want a fast build-and-deploy loop.
12+
13+
### What it does
14+
- Scaffold new mods with `hymod new`
15+
- Build mod artifacts with `hymod build`
16+
- Link artifacts into local servers with `hymod link`
17+
- Run an end-to-end dev loop with `hymod dev`
18+
- Deploy mods to remote servers with `hymod deploy`
19+
20+
### Who this is for
21+
- Hytale server owners
22+
- Java/Rust mod developers
23+
- Teams that want repeatable mod build and deployment workflows
724

825
## License
926

@@ -13,11 +30,6 @@ View hymod Development Progress:
1330

1431
* **Your Mods:** [MIT-0](./LICENSE-TEMPLATES). 100% yours. The code generated by `hymod new` is not covered by the GPLv3. You can release your mods under any license you want (closed source, MIT, etc) and you do not need to attribute `hymod`.
1532

16-
17-
## Overview
18-
19-
Hymod is a Rust workspace project for Hytale server modifications.
20-
2133
## Test Coverage
2234

2335
Test coverage is automatically generated and published to GitHub Pages on every push to the `master` branch. The coverage report provides detailed line-by-line coverage information for all crates in the workspace.

0 commit comments

Comments
 (0)