From e3af2b719e15043ab14040207c1ee379a7deb141 Mon Sep 17 00:00:00 2001 From: Vlad Arbatov Date: Sun, 27 Oct 2024 03:53:56 +0300 Subject: [PATCH] docs(readme,-contrib): nano changes --- CONTRIBUTING.md | 13 +++++-------- README.md | 2 +- 2 files changed, 6 insertions(+), 9 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 74edc0a..79cd4c3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -21,28 +21,25 @@ First of all, thank you for taking the time to contribute! 🎉 ## Development Workflow 1. Make your changes in the new branch. -2. **Test** your changes before submitting a PR: - ```bash - npm run test - ``` -3. Run **linting** to ensure code style: + +2. Run **linting** to ensure code style: ```bash npm run lint ``` -4. Once you're done, **commit** your changes using Commitizen: +3. Once you're done, **commit** your changes using Commitizen: ```bash git add . npm run commit ``` - We use [Commitizen](https://github.com/commitizen/cz-cli) to ensure consistent commit messages. Follow the prompts to create a meaningful commit message. -5. **Push** your branch to GitHub: +4. **Push** your branch to GitHub: ```bash git push origin feature/your-feature-name ``` -6. **Create a Pull Request** (PR) on GitHub: +5. **Create a Pull Request** (PR) on GitHub: - Include a detailed description of your changes. - Reference related issues if applicable. diff --git a/README.md b/README.md index 6e2e870..c939bca 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ **Detecto is a React library designed to help developers automatically detect when a user's browser is experiencing performance issues such as throttling or lag**. When performance issues are detected, the application can adapt to provide a smoother, more lightweight experience for the user. -Modern websites often feature rich animations, high-resolution images, and interactive elements that can be resource-intensive, especially on older or low-powered devices. By using Detecto, you can detect when the user's browsing environment is struggling and adjust your UI dynamically to keep the user experience optimal, even under less-than-ideal conditions. +Modern websites often feature rich animations, high-resolution images, and interactive elements that can be resource-intensive, especially on older or low-powered devices. By using Detecto, you can *detect* when the user's browsing environment is struggling and adjust your UI dynamically to keep the user experience optimal, even under less-than-ideal conditions. ## Key Features