From 8f1088a0f8bd3fc191bac0346ea4df34e1a02c6d Mon Sep 17 00:00:00 2001 From: Kevin FEDYNA Date: Tue, 28 Jan 2025 23:43:36 +0100 Subject: [PATCH] Deno police --- contributing.md | 11 ++++++++--- readme.md | 34 +++++++++++++++++++++++++--------- 2 files changed, 33 insertions(+), 12 deletions(-) diff --git a/contributing.md b/contributing.md index e31eacc..1aa5120 100644 --- a/contributing.md +++ b/contributing.md @@ -1,6 +1,10 @@ # Contributing -Thank you for your interest in contributing to our project! We appreciate your help in making this project better. To get started with contributing, please refer to our [Contributing Guide](https://github.com/fedyna-k/PolyMPR/wiki/Contributing) on the project's wiki. +Thank you for your interest in contributing to our project! We appreciate your +help in making this project better. To get started with contributing, please +refer to our +[Contributing Guide](https://github.com/fedyna-k/PolyMPR/wiki/Contributing) on +the project's wiki. The Contributing Guide provides detailed information on how to: @@ -10,6 +14,7 @@ The Contributing Guide provides detailed information on how to: - Follow our coding standards and guidelines - Report bugs and suggest improvements -If you have any questions or need further assistance, feel free to reach out to us by opening an issue or contacting the maintainers directly. +If you have any questions or need further assistance, feel free to reach out to +us by opening an issue or contacting the maintainers directly. -Happy coding! πŸ’»βœ¨ \ No newline at end of file +Happy coding! πŸ’»βœ¨ diff --git a/readme.md b/readme.md index 403ac57..e3214d5 100644 --- a/readme.md +++ b/readme.md @@ -1,22 +1,34 @@ # ✨ PolyMPR ✨ -**PolyMPR** (Poly Management Platform for Resources) is a modern, modular framework built on **Deno** and **Fresh**, designed to help organizations transition their HR systems to the cloud. With its **modulith architecture**, PolyMPR simplifies the development, deployment, and maintenance of HR applications, making it the perfect choice for teams looking to modernize their workflows. 🌐 +**PolyMPR** (Poly Management Platform for Resources) is a modern, modular +framework built on **Deno** and **Fresh**, designed to help organizations +transition their HR systems to the cloud. With its **modulith architecture**, +PolyMPR simplifies the development, deployment, and maintenance of HR +applications, making it the perfect choice for teams looking to modernize their +workflows. 🌐 ## Features ✨ -- **Modular Design**: Easily add, remove, or update features without disrupting the entire system. 🧩 -- **Cloud-Native**: Built for the cloud, enabling seamless integration with cloud services (amU DataCenter). ☁️ +- **Modular Design**: Easily add, remove, or update features without disrupting + the entire system. 🧩 +- **Cloud-Native**: Built for the cloud, enabling seamless integration with + cloud services (amU DataCenter). ☁️ - **Deno-Powered**: Utilizes Deno's secure runtime for TypeScript. πŸ¦• -- **Fresh Framework**: Delivers fast, edge-ready web applications with minimal overhead. ⚑ +- **Fresh Framework**: Delivers fast, edge-ready web applications with minimal + overhead. ⚑ - **HR-Focused**: Tailored to meet the unique needs of INFO's HR. πŸ‘©β€πŸ’ΌπŸ‘¨β€πŸ’Ό ## Getting Started πŸ› οΈ ### Prerequisites -- **Deno**: Install Deno by following the [official guide](https://deno.land/#installation). -- **Docker** (optional): Install Docker for containerized deployments. Follow the [Docker installation guide](https://docs.docker.com/get-docker/). + +- **Deno**: Install Deno by following the + [official guide](https://deno.land/#installation). +- **Docker** (optional): Install Docker for containerized deployments. Follow + the [Docker installation guide](https://docs.docker.com/get-docker/). ### Installation + 1. Clone the PolyMPR repository: ```bash git clone https://github.com/fedyna-k/PolyMPR.git @@ -28,7 +40,8 @@ ``` 3. Access the application at `https://localhost`. -For detailed installation instructions, check out the [Installation Guide](./wiki/installation). +For detailed installation instructions, check out the +[Installation Guide](./wiki/installation). ## Modules Overview 🧩 @@ -49,7 +62,9 @@ For detailed CLI usage, check out the [CLI Documentation](./wiki/cli). ## Contributing 🀝 -We welcome contributions from the community! Whether you're fixing bugs, adding features, or improving documentation, your help is appreciated. Here’s how to get started: +We welcome contributions from the community! Whether you're fixing bugs, adding +features, or improving documentation, your help is appreciated. Here’s how to +get started: 1. Create a new issue. 2. Create a new branch for your changes: @@ -70,4 +85,5 @@ Join the PolyMPR community to connect with other users and developers: ## License πŸ“œ -PolyMPR is open-source and released under the **MIT License**. Feel free to use, modify, and distribute it as per the license terms. \ No newline at end of file +PolyMPR is open-source and released under the **MIT License**. Feel free to use, +modify, and distribute it as per the license terms.