Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
AlessioCoser committed Jan 9, 2025
1 parent 3265518 commit 50e5f34
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 2 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,4 @@ jobs:
node-version: 20
- run: npm ci
- run: npm run build
- run: npm test run
- run: npm test
8 changes: 7 additions & 1 deletion readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,12 @@ Super simple reactive state management with fine-grained reactive DOM elements.
## Examples
You can find some examples here: [Examples](https://github.com/AlessioCoser/doom-reactive-state/tree/master/examples)

## Install
Use your preferred package manager:
- `npm install doom-reactive-state`
- `yarn add doom-reactive-state`
- `pnpm add doom-reactive-state`

## Getting Started

This is a simple increment counter component
Expand Down Expand Up @@ -69,7 +75,7 @@ You can load the script from the github release url and start use it right away.
<html>
<head>
<!-- other stuff -->
<script src="https://github.com/AlessioCoser/doom-reactive-state/releases/download/1.1.1/doom-reactive-state.global.js"></script>
<script src="https://github.com/AlessioCoser/doom-reactive-state/releases/download/1.1.2/doom-reactive-state.global.js"></script>
</head>
<body>
<script type="application/javascript">
Expand Down

0 comments on commit 50e5f34

Please sign in to comment.