search

anthdm / superkit

MIT License
993 stars 84 forks source link

Update README with additional information around Templ and components #3

Closed nsa-yoda closed 1 month ago

nsa-yoda commented 3 months ago

Summary

This pull request updates the README.md file for the SUPERKIT project, focusing on improving clarity, detail, and professionalism. Key updates include detailed application structure descriptions, development server setup, hot reloading configuration, view creation with Templ, and validations.

Changes

  1. Getting Started

    • Application Structure: Detailed directory descriptions.
    • Development Server: Command for starting the server.
    • Hot Reloading: Explained feature and added note for Windows and WSL2 users.

  2. Creating Views with Templ

    • Guide on using Templ for type-safe view components.
    • Steps for defining components, creating templates, and rendering views.
    • Benefits of Templ: type safety, maintainability, and performance.

  3. Validations

    • Detailed validation framework section.
    • Explained Errors, Schema, validation functions, and rule sets.
    • Example validation schema provided.

Additional Information

Please review these updates and provide feedback or approval for merging. Thank you!