Skip to content

Commit 6859f0b

Browse files
committed
docs: update readme
1 parent b399cb2 commit 6859f0b

1 file changed

Lines changed: 8 additions & 5 deletions

File tree

README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,18 @@
1-
# hnxml.js
1+
# hnxml
22

33
[![JSR Badge](https://jsr.io/badges/@modernschoolproject/hnxml)](https://jsr.io/@modernschoolproject/hnxml)
44
[![Github Badge](https://img.shields.io/badge/Github-hnxml-black?logo=github)](https://github.com/Modern-School/hnxml)
55

6+
hnxml include Hnxml Standard and `hnxml.js`
7+
68
Hnxml Standard is a TypeScript-based XML schema specification for Hacknet
7-
extensions, and it is defined by `hnxml.js`. `hnxml.js` provides JSX/TSX
9+
Extension, and it is defined by `hnxml.js`. `hnxml.js` provides JSX/TSX
810
compatible authoring support with types and additional generator tools for
911
Hacknet-related content generating.
1012

11-
Note: This project is in preview and is not ready for production use. It may not
12-
yet fully implement all specifications.
13+
> [!WARNING]\
14+
> Note: This project is in heavy development and is not ready for production
15+
> use. It does not yet fully implement all specifications.
1316
1417
Example: [PCS-OS](https://github.com/FBIKdot/PCS-OS)
1518

@@ -20,7 +23,7 @@ You can access Hnxml Standard through:
2023
- Website generated by [Typedoc](https://typedoc.org/):
2124
[hnxml.js.org](https://hnxml.js.org) (Most recommended)
2225
- Source code: [GitHub Repository](https://github.com/Modern-School/hnxml)
23-
- [JSR package page](https://jsr.io/@modernschoolproject/hnxml/doc)
26+
- [JSR package page](https://jsr.io/@modernschoolproject/hnxml)
2427

2528
## Use `hnxml.js` with TSX
2629

0 commit comments

Comments
 (0)