From 44d266362cb0b2ba999f5fed7b42d0d8c6a930de Mon Sep 17 00:00:00 2001
From: Corbin Crutchley <git@crutchcorn.dev>
Date: Wed, 4 Sep 2024 20:46:12 -0700
Subject: [PATCH] chore: update README add CI tests

---
 .github/workflows/test.yml   | 23 +++++++++++++++++++++++
 packages/vue-redux/README.md | 25 ++++++++++++++++++++++---
 2 files changed, 45 insertions(+), 3 deletions(-)
 create mode 100644 .github/workflows/test.yml

diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
new file mode 100644
index 0000000..c4c8ca8
--- /dev/null
+++ b/.github/workflows/test.yml
@@ -0,0 +1,23 @@
+name: Tests
+
+on: [push, pull_request, workflow_dispatch]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: pnpm/action-setup@v4
+        with:
+          version: 9
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '18'
+          cache: 'pnpm'
+
+      - name: Install packages
+        run: pnpm install --frozen-lockfile
+
+      - name: Run tests
+        run: pnpm test
diff --git a/packages/vue-redux/README.md b/packages/vue-redux/README.md
index bf063fe..4fbe72c 100644
--- a/packages/vue-redux/README.md
+++ b/packages/vue-redux/README.md
@@ -3,13 +3,32 @@
 Official Vue bindings for [Redux](https://github.com/reduxjs/redux).
 Performant and flexible.
 
+![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/reduxjs/react-redux/test.yml?style=flat-square) [![npm version](https://img.shields.io/npm/v/@reduxjs/vue.svg?style=flat-square)](https://www.npmjs.com/package/@reduxjs/vue)
+[![npm downloads](https://img.shields.io/npm/dm/@reduxjs/vue.svg?style=flat-square)](https://www.npmjs.com/package/@reduxjs/vue)
+
 > [!WARNING]
 > This package is in alpha and is rapidly developing.
 
-# Features
+## Installation
+
+Vue Redux requires **Vue 3 or later**.
+
+To use React Redux with your React app, install it as a dependency:
+
+```bash
+# If you use npm:
+npm install @reduxjs/vue-redux
+
+# Or if you use Yarn:
+yarn add @reduxjs/vue-redux
+```
+
+You'll also need to [install Redux](https://redux.js.org/introduction/installation) and [set up a Redux store](https://redux.js.org/recipes/configuring-your-store/) in your app.
 
-- Compatible with Vue 3+
-- [Redux Toolkit](https://redux-toolkit.js.org/) support
+This assumes that you’re using [npm](http://npmjs.com/) package manager
+with a module bundler like [Webpack](https://webpack.js.org/) or
+[Browserify](http://browserify.org/) to consume [CommonJS
+modules](https://webpack.js.org/api/module-methods/#commonjs).
 
 # Usage