Skip to content

Commit

Permalink
1.0.0-alpha.2
Browse files Browse the repository at this point in the history
  • Loading branch information
bencroker committed Nov 24, 2024
1 parent f43717a commit b7fbc5d
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 8 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Release Notes for Datastar

## 1.0.0-alpha.2 - 2024-11-24

- Initial functional release.

## 1.0.0-alpha.1 - 2024-11-22

- Initial alpha release.
10 changes: 4 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,19 +9,17 @@

**This plugin is in alpha and its API may change.**

Datastar is a free plugin for [Craft CMS](https://craftcms.com/) that allows you to create real-time front-ends driven by Twig templates. It aims to replace the need for front-end frameworks such as React, Vue.js and Alpine.js + htmx, and instead lets you manage state and run logic all within your Twig templates.
This plugin integrates the [Datastar framework](https://data-star.dev/) into [Craft CMS](https://craftcms.com/), allowing you to create real-time front-ends driven by Twig templates. It aims to replace the need for front-end frameworks such as React, Vue.js and Alpine.js + htmx, and instead lets you manage state and run logic all within your Twig templates.

With Datastar, you have the ability to define state and manipulate the DOM in real-time on the front-end, and modify parts of the DOM with templates rendered on the back-end. Use-cases for Datastar are:
With Datastar, you have the ability to define state and manipulate the DOM in real-time on the front-end, while modify the DOM with templates rendered on the back-end. Use-cases:

- Live searching elements
- Loading more elements / Infinite scroll
- Paginating, ordering and filtering lists of elements
- Submitting forms and running actions
- Pretty much anything to do with reactive front-ends

Datastar is lightweight, performant and strongly opinionated about embracing hypermedia and removing front-end complexity. It can be used for anything from simple to complex use-cases.

Read [The Case for Datastar](https://github.com/putyourlightson/craft-datastar/discussions/2) and join in the discussion.
Datastar is lightweight, performant and strongly opinionated about embracing hypermedia and removing front-end complexity.

## Documentation

Expand All @@ -40,7 +38,7 @@ This plugin requires [Craft CMS](https://craftcms.com/) 5.0.0 or later.
To install the plugin, search for “Datastar” in the Craft Plugin Store, or install manually using composer.

```shell
composer require putyourlightson/craft-datastar:^1.0.0-alpha.1
composer require putyourlightson/craft-datastar:^1.0.0-alpha.2
```

---
Expand Down
4 changes: 2 additions & 2 deletions composer.json
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
{
"name": "putyourlightson/craft-datastar",
"description": "A real-time, template-driven hypermedia framework for Craft.",
"version": "1.0.0-alpha.1",
"version": "1.0.0-alpha.2",
"type": "craft-plugin",
"license": "mit",
"require": {
"php": "^8.2",
"craftcms/cms": "^5.0",
"putyourlightson/craft-datastar-module": "^1.0.0-alpha.1"
"putyourlightson/craft-datastar-module": "^1.0.0-alpha.2"
},
"require-dev": {
"craftcms/ecs": "dev-main",
Expand Down

0 comments on commit b7fbc5d

Please sign in to comment.