Skip to content

Commit 0e15fbe

Browse files
joaopalopes24joaopalopes24
authored
Merge pull request #1 from wireui/adjust-docs
[Docs]: Adjust Docs
2 parents bc888cd + c4fb7d0 commit 0e15fbe

File tree

6 files changed

+175
-97
lines changed

6 files changed

+175
-97
lines changed

‎.github/code-of-conduct.md

+130
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, religion, or sexual identity
10+
and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
- Demonstrating empathy and kindness toward other people
21+
- Being respectful of differing opinions, viewpoints, and experiences
22+
- Giving and gracefully accepting constructive feedback
23+
- Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
- Focusing on what is best not just for us as individuals, but for the
26+
overall community
27+
- All PR of new components should be own created or from a free source
28+
29+
Examples of unacceptable behavior include:
30+
31+
- The use of sexualized language or imagery, and sexual attention or
32+
advances of any kind
33+
- Trolling, insulting or derogatory comments, and personal or political attacks
34+
- Public or private harassment
35+
- Publishing others' private information, such as a physical or email
36+
address, without their explicit permission
37+
- Other conduct which could reasonably be considered inappropriate in a
38+
professional setting
39+
- Creating components using paid source code like Tailwind UI
40+
41+
## Enforcement Responsibilities
42+
43+
Community leaders are responsible for clarifying and enforcing our standards of
44+
acceptable behavior and will take appropriate and fair corrective action in
45+
response to any behavior that they deem inappropriate, threatening, offensive,
46+
or harmful.
47+
48+
Community leaders have the right and responsibility to remove, edit, or reject
49+
comments, commits, code, wiki edits, issues, and other contributions that are
50+
not aligned to this Code of Conduct, and will communicate reasons for moderation
51+
decisions when appropriate.
52+
53+
## Scope
54+
55+
This Code of Conduct applies within all community spaces, and also applies when
56+
an individual is officially representing the community in public spaces.
57+
Examples of representing our community include using an official e-mail address,
58+
posting via an official social media account, or acting as an appointed
59+
representative at an online or offline event.
60+
61+
## Enforcement
62+
63+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
64+
reported to the community leaders responsible for enforcement at
65+
GitHub.
66+
All complaints will be reviewed and investigated promptly and fairly.
67+
68+
All community leaders are obligated to respect the privacy and security of the
69+
reporter of any incident.
70+
71+
## Enforcement Guidelines
72+
73+
Community leaders will follow these Community Impact Guidelines in determining
74+
the consequences for any action they deem in violation of this Code of Conduct:
75+
76+
### 1. Correction
77+
78+
**Community Impact**: Use of inappropriate language or other behavior deemed
79+
unprofessional or unwelcome in the community.
80+
81+
**Consequence**: A private, written warning from community leaders, providing
82+
clarity around the nature of the violation and an explanation of why the
83+
behavior was inappropriate. A public apology may be requested.
84+
85+
### 2. Warning
86+
87+
**Community Impact**: A violation through a single incident or series
88+
of actions.
89+
90+
**Consequence**: A warning with consequences for continued behavior. No
91+
interaction with the people involved, including unsolicited interaction with
92+
those enforcing the Code of Conduct, for a specified period of time. This
93+
includes avoiding interactions in community spaces as well as external channels
94+
like social media. Violating these terms may lead to a temporary or
95+
permanent ban.
96+
97+
### 3. Temporary Ban
98+
99+
**Community Impact**: A serious violation of community standards, including
100+
sustained inappropriate behavior.
101+
102+
**Consequence**: A temporary ban from any sort of interaction or public
103+
communication with the community for a specified period of time. No public or
104+
private interaction with the people involved, including unsolicited interaction
105+
with those enforcing the Code of Conduct, is allowed during this period.
106+
Violating these terms may lead to a permanent ban.
107+
108+
### 4. Permanent Ban
109+
110+
**Community Impact**: Demonstrating a pattern of violation of community
111+
standards, including sustained inappropriate behavior, harassment of an
112+
individual, or aggression toward or disparagement of classes of individuals.
113+
114+
**Consequence**: A permanent ban from any sort of public interaction within
115+
the community.
116+
117+
## Attribution
118+
119+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
120+
version 2.0, available at
121+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
122+
123+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
124+
enforcement ladder](https://github.com/mozilla/diversity).
125+
126+
[homepage]: https://www.contributor-covenant.org
127+
128+
For answers to common questions about this code of conduct, see the FAQ at
129+
https://www.contributor-covenant.org/faq. Translations are available at
130+
https://www.contributor-covenant.org/translations.

‎.github/FUNDING.yml ‎.github/funding.yml

File renamed without changes.

‎.github/security.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Security Policy
2+
3+
**PLEASE DON'T DISCLOSE SECURITY RELATED ISSUES PUBLICLY!**
4+
5+
## Reporting a Vulnerability
6+
7+
If you discover a security vulnerability within WireUi,
8+
please send an email to our team at **[email protected]**.
9+
All security vulnerabilities will be promptly addressed.

‎README.md

-96
This file was deleted.

‎LICENSE ‎license.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2022 WireUi
3+
Copyright (c) WireUi
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

‎readme.md

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
<p align="center"><img src="https://wireui.dev/wireui/wireui-circle.png" height="100"></p>
2+
3+
<h2><p align="center">Alpine.js Hold Directive</p></h2>
4+
5+
<p align="center">
6+
<a href="https://github.com/wireui/alpinejs-hold-directive/actions"><img src="https://github.com/wireui/alpinejs-hold-directive/actions/workflows/test.yml/badge.svg" alt="Tests"></a>
7+
<a href="license.md"><img src="https://img.shields.io/github/license/wireui/alpinejs-hold-directive" alt="License" /></a>
8+
<a href="https://x.com/Wire_Ui"><img src="https://img.shields.io/twitter/url?url=https://x.com/Wire_Ui" alt="Twitter"></a>
9+
</p>
10+
11+
### 🚀 Introduction
12+
13+
The hold directive enables you to add a hold action to an element, triggering it when the button is held down.
14+
15+
### 📚 Documentation
16+
17+
Documentation for Alpine.js Hold Directive can be found on the [WireUi website](https://wireui.dev/packages/alpinejs-hold-directive).
18+
19+
### 🔧 Contributing
20+
21+
Thank you for considering contributing to WireUi Docs! The contribution guide can be found in the [WireUi documentation](https://wireui.dev/customize/contribution-guide).
22+
23+
### 📣 Follow the WireUi
24+
25+
Stay informed about WireUI, follow [@Wire_Ui](https://x.com/Wire_Ui) on Twitter and [WireUi](https://www.linkedin.com/company/wireui) on LinkedIn.
26+
27+
There will you see all the latest news about features, ideas, discussions and more...
28+
29+
### 💡 Philosophy
30+
31+
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!
32+
33+
### 📝 License
34+
35+
WireUi is open-sourced software licensed under the [MIT license](license.md).

0 commit comments

Comments
 (0)