Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Tinitto committed Nov 9, 2023
1 parent 43ed739 commit 6501d19
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# alpml

![CI](https://github.com/Tinitto/alpml/actions/workflows/ci.yml/badge.svg)

A Javascript framework without need for bundlers, based on Alpine.js

## Challenge
Expand All @@ -18,6 +20,10 @@ A Javascript framework without need for bundlers, based on Alpine.js

- Every alpml component **must** have at least one hyphen (-) in it, as all [Web components should](https://html.spec.whatwg.org/multipage/custom-elements.html#valid-custom-element-name).

## How to Use

- See the [examples](./examples/) folder for example usage.

## Contributing

- You need to have [nodejs +v16](https://nodejs.org/en/)
Expand All @@ -30,3 +36,7 @@ A Javascript framework without need for bundlers, based on Alpine.js
Copyright (c) 2020 [Martin Ahindura](https://github.com/Tinitto)

Licensed under the [MIT License](./LICENSE)

## Acknowledgements

- [Alpine.js](https://alpinejs.dev/) is at the core of this little framework. Thanks to Caleb Porzio and contributors.

0 comments on commit 6501d19

Please sign in to comment.