Skip to content

Create README.md and documentation #14

@codebyNJ

Description

@codebyNJ

Requesting the contributors to create a clean formated README.md with a clean documentation

Expected documentations

  • Database schema and authentication system built over firebase. Indexes that are used.
  • Architecture of Service worker and PWA.
  • Installation setup of clarify locally.

Expected README.md

  • Simple overview
  • Banner Image with logo.
  • Feature Section, How we are different
  • Srictly no emoji's
  • Simple summary of the product
  • Licensing with copyrights.
  • Tech Stack used.
  • Map to documentation page

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomers

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions