Skip to content

Add sample recipe and README documentation #9

Description

@ddvlamin

Objective

Create a sample recipe file for testing and write project README with API docs.

Details

  • Create sample_recipe.md as a valid markdown file with frontmatter and ingredients (e.g., Parmesan Chicken).
  • Modify README.md to document the project, its tech stack, setup, endpoints, OpenAPI interactive docs, and recipe parsing format.

Checklist

  • Create sample_recipe.md with YAML frontmatter and ingredients
  • Add project description, quick start, and available endpoints table to README.md
  • Ensure README contains all endpoints with descriptions
  • Verify quick start instructions work from fresh clone

Dependencies

None

Notes

A pull request (#11) has been opened to implement these changes.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't workingdocumentationImprovements or additions to documentation

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions