From 33a69b7f31924028db911f3bebebedb56da3cf67 Mon Sep 17 00:00:00 2001 From: rilaxik Date: Fri, 14 Jun 2024 18:09:54 +0000 Subject: [PATCH] Update Home --- Welcome.md => Home.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) rename Welcome.md => Home.md (66%) diff --git a/Welcome.md b/Home.md similarity index 66% rename from Welcome.md rename to Home.md index 2f8973f..2b51f56 100644 --- a/Welcome.md +++ b/Home.md @@ -1,4 +1,4 @@ -# Welcome to RageFW +# Rage Framework (RageFW) RageFW is a type-safe framework for developing Rage:MP servers. Designed with developers in mind, RageFW brings structure and efficiency to your Rage:MP servers, ensuring robust and maintainable code ## Features @@ -9,7 +9,13 @@ RageFW is a type-safe framework for developing Rage:MP servers. Designed with de - **Logging System:** Keep track of server activities and debug like a pro with our built-in, feature-rich logging system. After all, even virtual cops need evidence ## Getting Started -*soon* +You can find out more about our CLI [here](https://git.entityseven.com/entityseven/rage-framework/wiki/CLI) + +At the moment automation we have only works via [pnpm](https://pnpm.io/). To scaffold a basic project with minor settings you can use our CLI: + +``pnpm create rage-fw`` + +This will give you a few options, among them, you can find ``Initialize new project``. Use that option to scaffold a new project for yourself using the preferred frontend framework ## Contributing Join our community of developers and contribute to the ongoing development of RageFW. At the moment the only way to contribute is opening issues @@ -17,4 +23,7 @@ Join our community of developers and contribute to the ongoing development of Ra ## Support Need help? Reach out via our community forums or contact us directly through our support channels. We're committed to help you as we can +## License +Licensed under **Custom Attribution-NoDerivs Software License** + > *RageFW - because in the world of GTA:RP, nobody has time for type errors* \ No newline at end of file