🤘🏻 Meta

luxonauta · Aug 25, 2024 · aab396e · aab396e
1 parent 2ed7f73
commit aab396e
Show file tree

Hide file tree

Showing 2 changed files with 43 additions and 23 deletions.
diff --git a/.github/contributing.md b/.github/contributing.md
@@ -1,21 +1,37 @@
 # 🫱🏻‍🫲🏻 Contributing to Luxa
 
-Thanks for your interest in contributing to Luxa CSS! Please take a moment to review this document before submitting a [bug report](https://github.com/luxonauta/luxacss/issues) or a [pull request](https://github.com/luxonauta/luxacss/pulls).
+Thank you for your interest in contributing to Luxa CSS! Please review these guidelines before submitting a [bug report](https://github.com/luxonauta/luxacss/issues) or a [pull request](https://github.com/luxonauta/luxacss/pulls).
 
 ## 🦗 Bug reports
 
-The [issue tracker](https://github.com/luxonauta/luxacss/issues) is the preferred channel for bug reports, but please respect the following restrictions:
+Use the [issue tracker](https://github.com/luxonauta/luxacss/issues) for bug reports, with the following considerations:
 
-- Please do not use the issue tracker for personal support requests. [Open a question in our discussion forums](https://github.com/luxonauta/luxacss/discussions/new?category=help) instead.
-- Please do not use the issue tracker for feature requests. [Suggest any ideas you have using our discussion forums](https://github.com/luxonauta/luxacss/discussions/new?category=ideas) instead.
+- ✅ Bug reports and non-critical issues;
+- ❌ Personal support requests (use [discussion forums](https://github.com/luxonauta/luxacss/discussions/new?category=help) instead);
+- ❌ Feature requests (use [discussion forums](https://github.com/luxonauta/luxacss/discussions/new?category=ideas) instead).
 
 ## ↗️ Pull requests
 
-Good pull requests, patches, improvements, and new features are a fantastic help.
+We welcome pull requests for improvements and new features. Please follow these guidelines:
 
-**Please ask first before starting work on any significant new features.**
-We recommend that you first [suggest your feature idea in our discussion forums](https://github.com/luxonauta/luxacss/discussions/new?category=ideas).
+1. **Ask first**: before starting work on significant new features, [suggest your feature idea in our discussion forums](https://github.com/luxonauta/luxacss/discussions/new?category=ideas);
+2. **Target branch**: submit pull requests to the [`dev`](https://github.com/luxonauta/luxacss/tree/dev) branch;
+3. **Source files**:
 
-[`dev`](https://github.com/luxonauta/luxacss/tree/dev) branch is open to pull requests.
+- ✅ Edit files in [`/sass`](https://github.com/luxonauta/luxacss/tree/master/sass);
+- ❌ Do not edit [`/dist`](https://github.com/luxonauta/luxacss/tree/master/dist) files directly.
 
-**Do not edit [`/dist`](https://github.com/luxonauta/luxacss/tree/master/dist) files directly.** Edit the source files in [`/sass`](https://github.com/luxonauta/luxacss/tree/master/sass), then recompile the [`/dist`](https://github.com/luxonauta/luxacss/tree/master/dist) files with `npm build`.
+4. **Compilation**: After editing source files, recompile the [`/dist`](https://github.com/luxonauta/luxacss/tree/master/dist) files with:
+
+```bash
+npm run build
+```
+
+### 🆘 Getting Help
+
+For usage questions or other support:
+
+1. Check the [documentation](https://luxacss.com);
+2. [Open a new discussion](https://github.com/luxonauta/luxacss/discussions/new?category=help) in the Help category
+
+Thank you for contributing to Luxa CSS! 🧩
diff --git a/readme.md b/readme.md
@@ -11,31 +11,35 @@ A clean and lightweight kit that prioritizes minimalism, speed, and ease of main
 
 ## 🏗️ Installation
 
-There are three ways to get started:
+Choose one of these methods to get started:
 
-[Download the latest version](https://github.com/luxonauta/luxacss/archive/main.zip/?ref=luxacss.com) and link the CSS in the `<head>` of your website.
+### Direct Download
 
-> The GitHub repository also includes this documentation, so it's significantly bigger than the NPM package.
+[Download the latest version](https://github.com/luxonauta/luxacss/archive/main.zip/?ref=luxacss.com) and link the CSS in your HTML `<head>`.
 
-### Install from CDN
+> **Note**: The GitHub repository includes documentation, making it larger than the NPM package.
 
-Alternatively, you can easily include Luxa CSS in your project using a CDN. Choose the version that suits your needs:
+### CDN
+
+Include Luxa CSS via CDN:
 
 ```html
-<!-- 🦣 Expanded - 8KB -->
+<!-- Expanded (7.5KB) -->
 <link
   rel="stylesheet"
-  href="https://cdn.jsdelivr.net/npm/luxacss@1.0.8/dist/expanded/luxa.css"
+  href="https://cdn.jsdelivr.net/npm/luxacss@1.0.9/dist/expanded/luxa.css"
 />
 
-<!-- 🦐 Compressed - 6KB -->
+<!-- Compressed (6KB) -->
 <link
   rel="stylesheet"
-  href="https://cdn.jsdelivr.net/npm/luxacss@1.0.8/dist/compressed/luxa.min.css"
+  href="https://cdn.jsdelivr.net/npm/luxacss@1.0.9/dist/compressed/luxa.min.css"
 />
 ```
 
-### Install with a package manager
+### Package Manager
+
+Install using your preferred package manager:
 
 ```bash
 npm i luxacss
@@ -45,7 +49,7 @@ pnpm i luxacss
 bun i luxacss
 ```
 
-Then import it into your main layout/page:
+Then import it:
 
 ```jsx
 import "luxacss";
@@ -64,15 +68,15 @@ Or, import Luxa into your `.scss` file with [`@use`](https://sass-lang.com/docum
 
 ## ☕ Support this project
 
-Buy-me a coffee:
+If you find Luxa CSS helpful, consider supporting the project:
 
 - [Ko-Fi](https://ko-fi.com/luxonauta)
 - [GitHub Sponsors](https://github.com/sponsors/luxonauta)
 
 ## 🫱🏻‍🫲🏻 Contributing
 
-Please read our [contributing guidelines](./.github/contributing.md) if you want to contribute to Luxa CSS.
+Please read our [contributing guidelines](./.github/contributing.md) to get started.
 
 ## ©️ License
 
-Luxa CSS is released under the [MIT License](./license.md). You are free to use and modify it for your projects.
+Luxa CSS is released under the [MIT License](./license.md). Feel free to use and modify it for your projects. 🧩