diff --git a/README.md b/README.md index 53198cb..3af5ecc 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,25 @@ -# kristify +# Kristify -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).* +![generic docs](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/documentation/generic_vector.svg) +![risugamis-modloader](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/compact/unsupported/risugamis-modloader_vector.svg) -## Folder Structure -| Folder | Description | -| ---------- | ----------------------------------------------------------------------------------------- | -| `/src` | The source code! Contains the actual code of Kristify. | +A piece of software that lets you create **highly customizable** [Krist](https://krist.dev/) shops in modern versions of [ComputerCraft](https://modrinth.com/mod/cc-tweaked)! + +## 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). +| `/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). ## Example -![Kristly.kst](https://user-images.githubusercontent.com/53350357/210158377-a3b9c303-22e2-4856-bdc1-1e6a4a4c4855.png) -*Running Kristify shop with default theme* + +![Demon.kst](https://i.imgur.com/OtV4Ixj.png) +Running Kristify shop with default theme