Update README.md

[Swastik-K-Sahu]

Fixes: #3

This PR adds a comprehensive README.md file for the Magic ePaper Badge app. It covers:

• Project overview and feature list
• Setup instructions for Android and iOS
• Permissions required
• Branch policy for development and builds
• Contribution best practices
• Troubleshooting common issues
• License information

Summary by Sourcery

Documentation:

• Include project overview, features, setup instructions, permissions, branch policy, contribution guidelines, troubleshooting tips, and license information.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request completely rewrites the README.md file to provide comprehensive documentation for the Magic ePaper Badge app, including project overview, setup instructions, permissions, branch policy, contribution guidelines, troubleshooting, and license information.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change	Details	Files
Completely rewrites the README.md file to provide comprehensive project information.	Added a detailed project overview and feature list. Included comprehensive setup instructions for both Android and iOS development and running/building the app. Documented required permissions for the application. Outlined the project's branch policy for development and automated builds. Provided guidelines and best practices for contributing to the project. Added a section on troubleshooting common issues. Included information about the project's license.	README.md

Possibly linked issues

• Missing Project Setup Instructions in README.md #3: The PR adds setup instructions and contribution guidelines to README.md, addressing the missing information requested in the issue.

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey @Swastik-K-Sahu - I've reviewed your changes and they look great!

Here's what I looked at during the review

• 🟢 General issues: all looks good
• 🟢 Security: all looks good
• 🟢 Testing: all looks good
• 🟢 Complexity: all looks good
• 🟢 Documentation: all looks good

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[Swastik-K-Sahu]

@AsCress @kienvo can you review this?

[mariobehling]

Please resolve the conflicts.