Skip to content

Refatorar README #2

@renancvitor

Description

@renancvitor

Contexto

Refatorar README para se adequar ao padrão de projetos.

Objetivo

Tornar o README legível, transmitindo a funcionalidade principal do projeto todo (API RESTful e frontend). Manter no padrão do projeto backend.

Escopo

Inclui:

  • Criação de badge de status
  • Criação de índice
  • Criação de todas as seções pertinentes
  • Criação do LICENCE
  • Criação da estrutura do projeto documentada
  • Criação do COMMIT_CONVENTION.md

Não inclui:

  • Alterações no projeto fora documentação

Critérios de Aceite

  • Funcionalidade implementada conforme descrito
  • Testes adicionados ou atualizados (se aplicável)
  • Documentação atualizada (se aplicável)

Observações Técnicas

Descrever decisões arquiteturais, riscos ou restrições conhecidas (se aplicável).

Referências

Links, issues relacionadas ou documentação externa (se aplicável).
Sistema de Notificação de Estoque — API REST

Metadata

Metadata

Assignees

Labels

docsImprovements or additions to documentation

Projects

Status

Done

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions