updated readme file

CODE_OF_CONDUCT.md

@@ -0,0 +1,44 @@
+# 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, sex characteristics, 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:
+
+- 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 [email protected]
+. 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, version 1.4, available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+For answers to common questions about this code of conduct, see https://www.contributor-covenant.org/faq

CONTRIBUTING.md

@@ -0,0 +1,15 @@
+### Contributing Guidelines:
+
+[![GitHub pull requests](https://img.shields.io/github/issues-pr-raw/gita/Bhagavad-Gita-App?logo=git&logoColor=white)](https://github.com/gita/Bhagavad-Gita-App/compare) [![GitHub contributors](https://img.shields.io/github/contributors/gita/Bhagavad-Gita-App?logo=github)](https://github.com/gita/Bhagavad-Gita-App/graphs/contributors) [![Buddhadeb Chhetri](https://img.shields.io/badge/[email protected]?colorA=gray&colorB=dodgerblue&logo=github)](https://github.com/Buddhad/)
+
+- Write clear meaningful git commit messages (Do read [this](http://chris.beams.io/posts/git-commit/)).
+
+- Make sure your PR's description contains GitHub's special keyword references that automatically close the related issue when the PR is merged. (Check [this](https://github.com/blog/1506-closing-issues-via-pull-requests) for more info)
+
+- When you make very very minor changes to a PR of yours (like for example fixing a text in button, minor changes requested by reviewers) make sure you squash your commits afterward so that you don't have an absurd number of commits for a very small fix. (Learn how to squash at [here](https://davidwalsh.name/squash-commits-git))
+
+- When you're submitting a PR for a UI-related issue, it would be really awesome if you add a screenshot of your change or a link to a deployment where it can be tested out along with your PR. It makes it very easy for the reviewers and you'll also get reviews quicker.
+
+- Always create PR to `develop` branch.
+
+- Please read our [Code of Conduct](./CODE_OF_CONDUCT.md).

README.md

@@ -1,2 +1,97 @@
-# Bhagavad-Gita-App
-Flutter app for Gita
+
+<h1 align="center">Getting Started with Bhagavad Gita App </h1> 
+<br>
+
+<div align="center">
+
+[![Welcome to my profile](https://img.shields.io/badge/Hello,Programmer!-Welcome-blue.svg?style=flat&logo=github)](https://github.com/Ggita/Bhagavad-Gita-App)
+[![Open Source Love](https://badges.frapsoft.com/os/v2/open-source.svg?v=103)](https://github.com/gita/Bhagavad-Gita-App)
+![License](https://img.shields.io/badge/License-MIT-red)
+![Stars](https://img.shields.io/github/stars/gita/Bhagavad-Gita-App?style=flat&logo=github)
+![Forks](https://img.shields.io/github/forks/gita/Bhagavad-Gita-App?style=flat&logo=github)
+![Shree Bhagavad Gita](https://cdn.discordapp.com/attachments/926055068271251467/926426925164032051/splashScreen.png)
+</div>
+<br>
+
+## **Getting Started**
+[![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/gita/Bhagavad-Gita-App?logo=github)](https://gita/Bhagavad-Gita-App/) [![GitHub commit activity](https://img.shields.io/github/commit-activity/m/gita/Bhagavad-Gita-App?color=bluevoilet&logo=github)](https://github.com/gita/Bhagavad-Gita-App/commits/) [![GitHub repo size](https://img.shields.io/github/repo-size/gita/Bhagavad-Gita-App?logo=github)](https://github.com/gita/Bhagavad-Gita-App)
+
+For the quick start, you can follow the steps below:
+
+1. Star <a href="https://github.com/gita/Bhagavad-Gita-App" title="this">this</a> repository.
+2. Fork <a href="https://github.com/gita/Bhagavad-Gita-App" title="this">this</a> repository.
+3. Clone the **forked** repository.
+
+```yml
+git clone https://github.com/<your-github-username>/Bhagavad-Gita-App
+```
+
+3. Navigate to the project directory.
+
+```py
+cd Bhagavad-Gita-App
+```
+
+4. Create a new branch.
+
+```yml
+git checkout -b <your_branch_name>
+```
+
+Run the following command to install the required dependencies.
+
+1. `flutter doctor -v  ` - install the required dependencies
+2. `flutter run  ` - start the development server
+3. Open http://localhost:3000 in your browser
+
+4. [Contribute](../Bhagavad-Gita-App/CONTRIBUTING.md)
+
+5. Stage your changes and commit
+
+```css
+git add -a
+
+git commit -m "<your_commit_message>"
+```
+
+7. Push your local commits to the remote repo.
+
+```yml
+git push -u origin <your_branch_name>
+```
+
+8. Create a <a href="https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request" title="Pull Request">Pull-Request</a> to `main`.
+
+9. Congratulations! 🎉 you've made your contribution to <a href="https://github.com/gita/Bhagavad-Gita-App" title="Winter-of-Code-2.0-frontend">Bhagavad-Gita-App</a>.
+
+<h1 id="contribute">Contributing</h1>
+
+<p>
+   Thank you for your interest in contributing to our Repo! Pull requests are welcome. For fixing typos, please make a PR with your fixes. For other contributions, we suggest you to read our <a href="/CONTRIBUTING.md">contribution guidelines</a> to see how you can contribute to this project. We are happy for every contribution. 
+   <hr> 
+</p>
+<h1 id="prs">Issues & Pull Requests</h1>
+
+Before making pull requests please look at our contributing guidelines (coming soon). You can start working on the issue which are mentioned in issues section. Just drop a comment before working on the issue. Thank you!
+
+#  License & Copyright
+
+The code is this repo is licensed under the [MIT License](License). Feel free to use and share it as per the license.
+
+# ✨ Contributors
+
+<a href="https://github.com/gita/Bhagavad-Gita-App/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=gita/Bhagavad-Gita-App" />
+<<<<<<< HEAD
+</a>
+=======
+</a>
+
+---
+
+<div align="center">
+ <img src="https://forthebadge.com/images/badges/built-with-love.svg" alt="love" />
+ <img src="https://forthebadge.com/images/badges/thats-how-they-get-you.svg" alt="how">
+</div>
+
+>>>>>>> c5562951d67597c307fa1a655f7e66721274a881