From c4fb7d0b38bd76ab871f75b3c7dccf1b7d1213fe Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=C3=A3o=20Pedro=20Lopes?= Date: Thu, 23 May 2024 11:26:51 -0300 Subject: [PATCH] docs(docs): adjust docs --- .github/code-of-conduct.md | 130 +++++++++++++++++++++++++++ .github/{FUNDING.yml => funding.yml} | 0 .github/security.md | 9 ++ README.md | 96 -------------------- LICENSE => license.md | 2 +- readme.md | 35 ++++++++ 6 files changed, 175 insertions(+), 97 deletions(-) create mode 100644 .github/code-of-conduct.md rename .github/{FUNDING.yml => funding.yml} (100%) create mode 100644 .github/security.md delete mode 100644 README.md rename LICENSE => license.md (97%) create mode 100644 readme.md diff --git a/.github/code-of-conduct.md b/.github/code-of-conduct.md new file mode 100644 index 0000000..62ad600 --- /dev/null +++ b/.github/code-of-conduct.md @@ -0,0 +1,130 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, religion, or sexual identity +and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +- Demonstrating empathy and kindness toward other people +- Being respectful of differing opinions, viewpoints, and experiences +- Giving and gracefully accepting constructive feedback +- Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +- Focusing on what is best not just for us as individuals, but for the + overall community +- All PR of new components should be own created or from a free source + +Examples of unacceptable behavior include: + +- The use of sexualized language or imagery, and sexual attention or + advances of any kind +- Trolling, insulting or derogatory comments, and personal or political attacks +- Public or private harassment +- Publishing others' private information, such as a physical or email + address, without their explicit permission +- Other conduct which could reasonably be considered inappropriate in a + professional setting +- Creating components using paid source code like Tailwind UI + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +GitHub. +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series +of actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or +permanent ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within +the community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.0, available at +https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. + +Community Impact Guidelines were inspired by [Mozilla's code of conduct +enforcement ladder](https://github.com/mozilla/diversity). + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see the FAQ at +https://www.contributor-covenant.org/faq. Translations are available at +https://www.contributor-covenant.org/translations. diff --git a/.github/FUNDING.yml b/.github/funding.yml similarity index 100% rename from .github/FUNDING.yml rename to .github/funding.yml diff --git a/.github/security.md b/.github/security.md new file mode 100644 index 0000000..a3c0630 --- /dev/null +++ b/.github/security.md @@ -0,0 +1,9 @@ +# Security Policy + +**PLEASE DON'T DISCLOSE SECURITY RELATED ISSUES PUBLICLY!** + +## Reporting a Vulnerability + +If you discover a security vulnerability within WireUi, +please send an email to our team at **security@wireui.dev**. +All security vulnerabilities will be promptly addressed. diff --git a/README.md b/README.md deleted file mode 100644 index fbd419c..0000000 --- a/README.md +++ /dev/null @@ -1,96 +0,0 @@ -

- - GitHub license - - - Twitter - -

- -# Alpine.js Hold Directive - -[![Tests](https://github.com/wireui/alpinejs-hold-directive/actions/workflows/test.yml/badge.svg)](https://github.com/wireui/alpinejs-hold-directive/actions/workflows/test.yml) - -### 🔥 Hold Directive -The hold directive allows you to add a hold action to an element and call it when the button is holding. - -### 📚 Get Started -#### Prerequisites: -* [Alpinejs 3.10+](https://alpinejs.dev) - -#### Install -```bash -yarn add @wireui/alpinejs-hold-directive - -or - -npm i @wireui/alpinejs-hold-directive --save -``` - -#### Configure -```diff -// resources/js/app.js -import Alpine from 'alpinejs' - -+ import HoldDirective from '@wireui/alpinejs-hold-directive' -+ HoldDirective.register(Alpine) - -// or - -+ import { directive } from '@wireui/alpinejs-hold-directive' -+ Alpine.directive('hold', directive) - -window.Alpine = Alpine - -Alpine.start() -``` - -#### How to use it? -You can use the x-hold directive to call any alpine.js action. - -```html -
- - - -
-``` - -#### Directive API -| Modifier | Description | Default | -|---------------------|-------------------------------------------|---------| -| x-hold.500ms | Set the wait time to repeat the action | | -| x-hold.repeat | Set the wait time to repeat the action | 500ms | -| x-hold.repeat.500ms | Set the wait time to repeat the action | | -| x-hold.delay | Set the wait time to start holding | 500ms | -| x-hold.delay.500ms | Set the wait time to start holding | | -| x-hold.click | Fire the hold action with the click event | false | - -All modifiers can be used together. - -Just set the modifier duration after the modifer name, **`x-hold.delay.500ms`**. - -

📣 Follow the Author

- -Stay informed, follow [@ph7jack] on Twitter. - -There will you see all the latest news about features, ideas, discussions and more... - -

💡 Philosophy

- -WireUI is and will always be FREE to anyone who would like to use it. - -This project is created [Pedro Oliveira], and it is maintained by the author with the help of the community. - -All contributions are welcome! - -## License - -[MIT](https://opensource.org/licenses/MIT) - -[@ph7jack]: https://twitter.com/ph7jack -[Pedro Oliveira]: https://github.com/PH7-Jack diff --git a/LICENSE b/license.md similarity index 97% rename from LICENSE rename to license.md index 74b7896..e29b49a 100644 --- a/LICENSE +++ b/license.md @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2022 WireUi +Copyright (c) WireUi Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..bef91e8 --- /dev/null +++ b/readme.md @@ -0,0 +1,35 @@ +

+ +

Alpine.js Hold Directive

+ +

+Tests +License +Twitter +

+ +### 🚀 Introduction + +The hold directive enables you to add a hold action to an element, triggering it when the button is held down. + +### 📚 Documentation + +Documentation for Alpine.js Hold Directive can be found on the [WireUi website](https://wireui.dev/packages/alpinejs-hold-directive). + +### 🔧 Contributing + +Thank you for considering contributing to WireUi Docs! The contribution guide can be found in the [WireUi documentation](https://wireui.dev/customize/contribution-guide). + +### 📣 Follow the WireUi + +Stay informed about WireUI, follow [@Wire_Ui](https://x.com/Wire_Ui) on Twitter and [WireUi](https://www.linkedin.com/company/wireui) on LinkedIn. + +There will you see all the latest news about features, ideas, discussions and more... + +### 💡 Philosophy + +WireUI is and will always be FREE to anyone who would like to use it. This project is created by [Pedro Oliveira](https://github.com/PH7-Jack), and it is maintained by the author and your team with the help of the community. All contributions are welcome! + +### 📝 License + +WireUi is open-sourced software licensed under the [MIT license](license.md).