dnrops
/
datastar
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Minor tweaks

This commit is contained in:
Ben Croker 2024-11-22 09:42:42 +01:00
parent af1205a298
commit a19821ff36
No known key found for this signature in database
GPG Key ID: 09D799816F1CF332
2 changed files with 8 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
CONTRIBUTING.md
View File

@ -6,7 +6,7 @@ Thanks for thinking about contributing to Datastar 🚀
Before you contribute, please consider that Datastar is a lightweight JavaScript framework that aims to simplify real-time, interactive web apps by using a minimalist, attribute-based approach for state management and event handling directly in HTML.
Anything outside of this scope may not be accepted. If you have a need for a feature that is not within the scope of Datastar, consider using a Web Component or writing your own Datastar plugin [needs further explanation].
Anything outside of this scope may not be accepted. If you have a need for a feature that is not within the scope of Datastar, consider using a Web Component or writing your own Datastar plugin.
## Bug Reports & Feature Requests
@ -14,7 +14,7 @@ Before submitting bug reports and feature requests, please search the [open issu
## Documentation
Datastar’s documentation is under active development. All the markdown files live in [this folder](https://github.com/starfederation/datastar/tree/main/code/go/site/static/md). Improvements to them can be submitted via pull requests.
Datastar’s documentation is under active development. All the markdown files live in [this folder](https://github.com/starfederation/datastar/tree/develop/code/go/site/static/md). Improvements to them can be submitted via pull requests.
## Pull Requests

13
README.md
View File

@ -20,8 +20,10 @@ Here’s what frontend reactivity looks like using Datastar:
<div data-text="$input.toUpperCase()"></div>
<button data-on-click="$post('/endpoint')">Save</button>
```
https://discord.com/channels/1296224603642925098/1296224603642925102
Visit the [Datastar Website »](https://data-star.dev/)
Visit the [Datastar Website »](https://data-star.dev/)
Join the [Discord Server »](https://discord.com/channels/1296224603642925098/1296224603642925102)
## Getting Started
@ -66,12 +68,9 @@ Datastar.load(
npm install @starfederation/datastar
```
[!IMPORTANT] Only use the NPM package if you are using a bundler like Vite or it's part of a legacy project.
> [!IMPORTANT]
> Only use the NPM package if you are using a bundler like Vite or if it’s part of a legacy project.
## Contributing
Read the [Contribution Guidelines »](CONTRIBUTING.md)
## Development
Read the [Development Guidelines »](DEVELOPMENT.md)