diff --git a/README.md b/README.md index b8e395a..26826d1 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,57 @@ -AsaJS Logo made by [Kammasy](https://www.youtube.com/channel/UCrmjDWdM8-ZSeekzLeCnftg) a.k.a **[E.G.G](https://www.youtube.com/channel/UCrmjDWdM8-ZSeekzLeCnftg)** +
+ -![image](/resources/logo.png) +

+ AsaJS - The Minecraft: Bedrock Edition JSON-UI Framework +

+ +[![asajs version](https://img.shields.io/npm/v/asajs.svg?style=for-the-badge&labelColor=000000)](https://www.npmjs.com/package/asajs) +[![asajs license](https://img.shields.io/npm/l/asajs.svg?style=for-the-badge&labelColor=000000)](https://github.com/AsakiYuki/AsaJS/blob/main/README.md) +[![asajs downloads](https://img.shields.io/npm/dm/asajs.svg?style=for-the-badge&labelColor=000000)](https://www.npmjs.com/package/asajs) +
+ +**AsaJS** is a NodeJS library designed to empower developers to create **JSON-UI** packages for Minecraft: Bedrock Edition using **JavaScript** or **TypeScript**. + +Say goodbye to the tedious and repetitive nature of manual JSON editing. AsaJS streamlines your workflow by bringing the programmatic flexibility to Minecraft UI development. + +## 🛠 Installation + +To use AsaJS, ensure you have **[Node.js](https://nodejs.org/en)** installed on your system. + +**Latest stable version:** + +```bash +npm install asajs +``` + +**For our nightly builds:** + +``` +npm install asajs@indev +``` + +## 📖 "Hello World!" Example + +Creating a custom UI with AsaJS is straightforward. Here is how you can insert a custom label onto the Minecraft Start Screen: + +```javascript +import { Anchor, Label, Modify } from "asajs" + +const label = Label({ + text: "Hello World from my Custom UI!", + shadow: true, + anchor: Anchor.TOP_MIDDLE, + offset: [0, 10], +}) + +// This code injects the label into the top of the start screen +Modify("start", "start_screen_content").insertChild(label) +``` + +## 📚 Documentation + +Detailed guides and API references are available at: 👉 https://asajs.asakiyuki.com/ + +## 🤝 Contributing + +Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**. diff --git a/test/app.ts b/test/app.ts index 42ea928..29a503a 100644 --- a/test/app.ts +++ b/test/app.ts @@ -1 +1,10 @@ -import { Panel } from ".." +import { Anchor, Label, Modify } from ".." + +const label = Label({ + text: "Hello World from my Custom UI!", + shadow: true, + anchor: Anchor.TOP_MIDDLE, + offset: [0, 10], +}) + +Modify("start", "start_screen_content").insertChild(label)