diff --git a/README.md b/README.md index bc4c416d..57b90aa0 100644 --- a/README.md +++ b/README.md @@ -23,21 +23,39 @@ Potential benefits: Django-components can be particularly useful for larger Django projects that require a more structured approach to UI development, without necessitating a shift to a separate frontend framework. -## Summary +## Quickstart -It lets you create "template components", that contains both the template, the Javascript and the CSS needed to generate the front end code you need for a modern app. Use components like this: +django-components lets you create reusable blocks of code needed to generate the front end code you need for a modern app. + +Define a component in `components/calendar/calendar.py` like this: +```python +@register("calendar") +class Calendar(Component): + template_name = "template.html" + + def get_context_data(self, date): + return {"date": date} +``` + +With this `template.html` file: ```htmldjango -{% component "calendar" date="2015-06-19" %}{% endcomponent %} +