improve documentation

CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# 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
+
+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
+
+## 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
+zaniecompany@gmail.com.
+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.

CONTRIBUTING.md

@@ -1 +1,56 @@
-This file will contain details on how can anyone contribute to the repository
+# Contributing Guidelines
+
+This document contains a set of guidelines to help you during the contribution process.
+We are happy to welcome all the contributions from anyone willing to improve this project in any way. Thank you for choosing this repository to contribute and helping out this project grow, We accept contributions of every size.
+
+## Before you begin:
+
+- Have you read the [code of conduct](https://github.com/aakzsh/zanie/blob/master/CODE_OF_CONDUCT.md) ?
+- Check out the [existing issues](https://github.com/aakzsh/zanie/issues) & see if we accept contributions for your type of issue.
+
+## Table of Contents :
+
+- [Project Conventions](#project-conventions)
+- [Find an issue/potential feauture](find-an-issue--or-make-one--)
+- [Labels](#labels)
+- [Work on the issue assigned](#work-on-the-issue-assigned)
+- [Pull Request](#pull-request)
+- [Additional help](#need-help-)
+
+---
+
+## Project Conventions
+- All the explicit widget created must go inside lib folder, in a new file or an existing dart file.
+- All the styles that are implemented would go into separate file NOT inline.
+
+## Find an issue/potential features:
+
+- **Note :** Every change in this project should have an associated issue ( very small changes can be an exception but it's still recommended to have an issue for you change ).
+- All kinds of issues are accepted as far as they're relevant and are enhancing app's quality, features, speed, design or making the documentation better or are related to website for zanie.
+- Take a look at the [Existing Issues](https://github.com/aakzsh/zanie/issues) or create your [**own** Issue](https://github.com/aakzsh/zanie/issues/new/choose).
+- Show your interest by commenting on the issue you want to work on and the maintainers will assign you the issue.
+
+
+## Labels
+Labels can help you find an issue you'd like to help with.
+
+- The `help wanted` label is for problems or updates that anyone in the community can start working on.
+- The `good first` issue label is for problems or updates we think are ideal for beginners.
+
+## Work on the issue assigned
+- Make sure the changes follow our [**Project Conventions**](https://github.com/aakzsh/zanie/blob/master/CONTRIBUTING.md#project-conventions)
+- Keep your commits clean.
+- Make sure to update the documentation accordingly (if required).
+
+## Pull Request
+
+- Go to your fork and create a pull request from there.
+- Wait for it to be reviewed and merge by the maintainers/moderators.
+- Celebrate :tada:
+
+## Need help ?
+
+You can refer to the following articles on basics of Git and Github and also don't hasitate to ask for help from project maintainers in case you face any problem or find yourself stuck somewhere in the process :
+- [Forking a Repository](https://docs.github.com/en/get-started/quickstart/fork-a-repo)
+- [Cloning a Repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository)
+- [Creating a Pull Request](https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request)

README.md

@@ -1 +1,26 @@
-<!-- todo: add readme content -->
+This repository accepts PRs as a participation in hacktoberfest as well, given that the PRs are not spammy and are actually solving some issue/enhancing existing features or improving the documentation.
+
+## Getting Started
+
+### Clone the repo
+   ```sh
+   git clone https://github.com/aakzsh/zanie.git && cd ./zanie
+   ```
+### Install packages
+   ```sh
+   dart pub get
+   ```
+### Run the application
+  ```sh
+  flutter run
+  ```
+
+## About Zanie
+<img src="https://github.com/aakzsh/zanie/blob/master/assets/zanie.svg">
+<br>
+Zanie is a mobile application built on the top of flutter to serve as a magically themed up voice assistant. For now, it can perform basic functions like answering to simple questions [not powered by ML yet], open another apps on command. <br>
+We've planned bunch of more features like removing the QR Code scan thingy, letting users play some simple games to maybe earn coins, UI redesigning, adding ML and AI to let it answer questions and solving critical performance issues and more.
+
+For a more detailed info, check [ZANIE.md](https://github.com/aakzsh/zanie/blob/master/ZANIE.md)
+
+Wanna contribute? checkout [ZANIE.md](https://github.com/aakzsh/zanie/blob/master/CONTRIBUTING.md)