Merge pull request #3 from jrgarciadev/workspaces

chore: add readme and related files

CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+- The use of sexualized language or imagery and unwelcome sexual attention or advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers 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, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at xingmin.zhu@alipay.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

CONTRIBUTING.MD

@@ -0,0 +1,25 @@
+# Next UI Contributing Guide
+
+Hello!, I am very excited that you are interested in contributing with Next UI. However, before submitting your contribution, be sure to take a moment and read the following guidelines.
+
+- [Code of Conduct](https://github.com/jrgarciadev/nextui/blob/main/CODE_OF_CONDUCT.md)
+- [Extraction request guidelines](#pull-request-guidelines)
+- [Development Setup](#development-setup)
+
+## Pull Request Guidelines
+
+- The `main` branch is basically a snapshot of the latest stable version. All development must be done in dedicated branches.
+- It is good to have multiple small commits while working on the PR. We'll let GitHub squash it automatically before the merge.
+- If you add a new feature:
+  - Add the test case that accompanies it.
+  - Provide a compelling reason to add this feature. Ideally, I would first open a suggestion topic and green it before working on it.
+- If you correct an error:
+  - If you are solving a special problem, add (fix #xxxx [, # xxx]) (# xxxx is the problem identification) in your PR title for a better launch record, for example update entities encoding / decoding (fix # 3899).
+  - Provide a detailed description of the error in the PR. Favorite live demo.
+  - Add the appropriate test coverage, if applicable.
+
+## Development Setup
+
+After cloning the repository, execute:
+
+TODO:

README.md

@@ -0,0 +1,74 @@
+![Logo](https://dev-to-uploads.s3.amazonaws.com/uploads/articles/th5xamgrr6se0x5ro4g6.png)
+
+Add badges from somewhere like: [shields.io](https://shields.io/)
+
+[![MIT License](https://img.shields.io/apm/l/atomic-design-ui.svg?)](https://github.com/tterb/atomic-design-ui/blob/master/LICENSEs)
+[![GPLv3 License](https://img.shields.io/badge/License-GPL%20v3-yellow.svg)](https://opensource.org/licenses/)
+[![AGPL License](https://img.shields.io/badge/license-AGPL-blue.svg)](http://www.gnu.org/licenses/agpl-3.0)
+
+## Browser support
+
+Recent versions of Firefox, Chrome, Edge, Opera and Safari. IE11+
+
+## Supporting through Patreon
+
+Any additional information goes here
+
+## Introduction
+
+A brief description of what this project does and who it's for
+
+## Support
+
+If you feel awesome and want to support us in a small way, please consider starring and sharing the repo! This helps us getting known and grow the community. 🙏
+
+## Installation
+
+Install my-project with npm
+
+```bash
+  npm install my-project
+  cd my-project
+```
+
+## Components
+
+You can also view all developed components in [Storybook](https://linktodocumentation)
+
+- [Component 1](https://linktodocumentation)
+- [Component 2](https://linktodocumentation)
+- [Component 3](https://linktodocumentation)
+- [Component 4](https://linktodocumentation)
+- [Component 5](https://linktodocumentation)
+- [Component 6](https://linktodocumentation)
+- [Component 7](https://linktodocumentation)
+- [Component 8](https://linktodocumentation)
+
+## Usage/Examples
+
+```javascript
+import Component from 'my-project';
+
+function App() {
+  return <Component />;
+}
+```
+
+## Contributing
+
+Contributions are always welcome!
+
+See `CONTRIBUTING.md` for ways to get started.
+
+Please adhere to this project's `CODE_OF_CONDUCT`.
+
+## Related
+
+Here are some related projects
+
+- [Vuesax](https://github.com/matiassingers/awesome-readme)
+- [Geist UI](https://github.com/matiassingers/awesome-readme)
+
+## License
+
+[MIT](https://choosealicense.com/licenses/mit/)