diff --git a/README.md b/README.md index 1d6b874..b4d0f6e 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,16 @@ # kristify -A piece of software that let's you create [Krist](https://krist.dev/) shops in modern version of [ComputerCraft](https://tweaked.cc) -No other mods than ComputerCraft ([Tweaked](https://modrinth.com/mod/cc-tweaked) or [Restitched](https://modrinth.com/mod/cc-restitched)) are required. +A piece of software that let's you create **highly customizable** [Krist](https://krist.dev/) shops in modern versions of [ComputerCraft](https://tweaked.cc)! +*Supports CC: [Tweaked](https://modrinth.com/mod/cc-tweaked) or [Restitched](https://modrinth.com/mod/cc-restitched).* -## Folder Structure - -| Folder | Description | -| ---------- | -------------------------------------------------------------------- | -| `/src` | The source code! This file will be compiled into `kristify.lua`. | -| `/data` | All types of data. Examples: Config, products, chests, etc. | -| `/docs` | The documentation folder. This folder is not included in production. | -| `/.github` | All github related stuff. Not included in production | -| `/.vscode` | All VSCode related stuff. Not included in production | - -## Documentation - -Our documentation is hosted on [`kristify.github.io`](https://kristify.github.io). +## Folder Structure +| Folder | Description | +| ---------- | ----------------------------------------------------------------------------------------- | +| `/src` | The source code! Contains the actual code of Kristify. | +| `/data` | All types of data. E.g. products, configs, layout, etc. (Can be modified by the enduser) | +| `/docs` | The documentation folder. (Not included in production) | +| `/.github` | All github related stuff. (Not included in production) | +| `/.vscode` | All VSCode related stuff. (Not included in production) | + +## Documentation +Our documentation is hosted on [`kristify.madefor.cc`](https://kristify.madefor.cc).