chore: Readme (#36)

* Add Readme, code of conduct and contributing

* Install local app

* Update twitter account

* Add socials to the Readme

* Fix license link

* Update README.md

* Update README.md

CODE_OF_CONDUCT.md

@@ -0,0 +1,43 @@
+# 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, education, socio-economic status, 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. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and 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](https://www.contributor-covenant.org/), version 1.4, available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

CONTRIBUTING.md

@@ -0,0 +1,74 @@
+# Contributing to Ignite Apps
+
+We warmly welcome contributions to the Ignite Apps project! This document provides guidelines for contributing to the Ignite Apps repository. By following these guidelines, you can help us maintain a healthy and sustainable open-source ecosystem.
+
+## Code of Conduct
+
+This project and everyone participating in it is governed by the [Ignite Apps Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to the team.
+
+## How to Contribute
+
+### Reporting Bugs
+
+Before submitting a bug report, please check if the issue has already been reported. If it has not, create a new issue and include:
+
+- A clear title and description.
+- As much relevant information as possible (e.g., version, environment).
+- A code sample or an executable test case demonstrating the expected behavior that is not occurring.
+
+### Suggesting Enhancements
+
+Enhancement suggestions are also welcome. Open an issue and include:
+
+- A clear title and description of the enhancement.
+- Explain why this enhancement would be useful.
+- Provide a use case or code examples if possible.
+
+### Pull Requests
+
+1. Fork the repository and create your branch from `main`.
+2. If you've added code that should be tested, add tests.
+3. Ensure your code adheres to the existing style in the project to maintain consistency.
+4. Write clear, meaningful commit messages.
+5. Include appropriate tests.
+6. Add or update the documentation as necessary.
+7. After submitting your pull request, verify that all status checks are passing.
+
+### Development Setup
+
+For setting up your local development environment, follow these steps:
+
+```bash
+# Clone the Apps directory
+git clone https://github.com/ignite/apps.git && cd apps
+# Scaffold a template for your own app
+ignite scaffold app <name> && cd <name>
+# Install your app
+ignite app install -g $(pwd)
+```
+
+### **Contribution Prerequisites**
+
+- Familiarity with Git and GitHub.
+- Understanding of the project's technology stack and goals.
+
+## **Community**
+
+- Join the community conversations on [Discord](https://discord.com/invite/ignite) or [X/Twitter](https://twitter.com/ignite).
+- Follow the project's progress and updates.
+
+## **Pull Request Process**
+
+- Update the README.md or documentation with details of changes to the interface, if applicable.
+- Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent.
+- The pull request will be merged once it's reviewed and approved by the maintainers.
+
+## **License**
+
+**TODO**
+
+## **Questions?**
+
+If you have any questions about contributing, please feel free to contact us.
+
+Thank you for your interest in contributing to Ignite Apps!

README.md

@@ -1,6 +1,80 @@
-# Ignite Apps
+# **Ignite Apps**
 
-Official [Ignite CLI](https://ignite.com/cli) apps repository.
+Welcome to the Ignite App repository, a hub for enhancing blockchain app development with Ignite CLI. Our goal is to provide a platform where developers can find and share tools and insights, making blockchain application development more efficient and insightful.
 
-Each directory in the root of this repo must be a Go module containing
-an Ignite App package, each one with its own `go.mod` file.
+## **About Ignite Apps**
+
+Ignite Apps aims to extend the functionality of Ignite CLI, offering both official and community-contributed integrations. These integrations are designed to streamline development processes and offer valuable insights for blockchain app developers.
+
+### **Official Ignite Apps**
+
+- Developed by the core Ignite engineering team.
+- Rigorously tested and fully supported.
+- To submit your community-built app for official inclusion, please follow our submission guidelines.
+
+### **Community Build Apps**
+
+- A space for developers to share their Ignite integrations.
+- Open for contributions via pull requests.
+- To have your app reviewed for inclusion in the official section, please indicate this in your submission.
+
+## **Getting Started**
+
+### **How to Install an App**
+
+```bash
+ignite app install -g github.com/ignite/apps/[app-name]
+```
+
+Example: Installing the Hermes app
+
+```bash
+ignite app install -g github.com/ignite/apps/hermes
+```
+
+For more details, see [Installing Ignite Apps](https://docs.ignite.com/apps/using-apps).
+
+### **How to Create an App**
+
+Scaffold your Ignite app with one simple command:
+
+```bash
+ignite scaffold app path/to/your/app
+```
+
+Afterwards, install using:
+
+```bash
+ignite app install -g path/to/your/app
+```
+
+For more information, refer to [Creating Ignite Apps](https://docs.ignite.com/apps/developing-apps).
+
+## **Contributing**
+
+We welcome and appreciate new contributions. If you have an idea or an app that can benefit Ignite users, please follow our contribution guidelines.
+
+- Fork the repository.
+- Create your feature branch (**`git checkout -b feature/AmazingFeature`**).
+- Commit your changes (**`git commit -am 'Add some AmazingFeature'`**).
+- Push to the branch (**`git push origin feature/AmazingFeature`**).
+- Open a pull request.
+
+For detailed contribution guidelines, please refer to [CONTRIBUTING.md](CONTRIBUTING.md) and [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md).
+
+## **Repository Structure**
+
+Each directory in the root of this repository is a Go module containing an Ignite App package, with each app having its own go.mod file. This structure ensures modularity and ease of management for each app within the Ignite ecosystem.
+
+## **Support and Feedback**
+
+For support, questions, or feedback, please open an issue in this repository.
+
+## **License**
+
+This project is licensed under the [Copyright License](LICENSE) - see the [LICENSE](LICENSE) file for details.
+
+## **Community**
+
+- Join the community conversations on [Discord](https://discord.com/invite/ignite) or [X/Twitter](https://twitter.com/ignite).
+- Follow the project's progress and updates.