Tudor Stanciu a8927c17d8 feat: add comprehensive guidelines for generating PRDs and task lists
- Created a detailed Product Requirements Document (PRD) template to guide AI in generating PRDs based on user prompts.
- Added a structured task list generation process from PRDs to assist developers in implementation.
- Established task management protocols to ensure effective tracking and completion of tasks.
- Documented the tech stack used in the project, including backend and frontend technologies, build, release processes, and extra features.
2025-07-24 10:28:16 +03:00
2025-07-23 15:59:28 +00:00

Introduction

TODO: Give a short introduction of your project. Let this section explain the objectives or the motivation behind this project.

Getting Started

TODO: Guide users through getting your code up and running on their own system. In this section you can talk about:

  1. Installation process
  2. Software dependencies
  3. Latest releases
  4. API references

Build and Test

TODO: Describe and show how to build your code and run the tests.

Contribute

TODO: Explain how other users and developers can contribute to make your code better.

If you want to learn more about creating good readme files then refer the following guidelines. You can also seek inspiration from the below readme files:

Description
GeoIP lookup service with frontend interface
Readme 1.5 MiB
Languages
TypeScript 58.2%
C# 30.7%
CSS 7.1%
JavaScript 2.1%
Dockerfile 1.5%
Other 0.4%