From d67d18ab7766e8dbb79fd48ac347d601f82d3332 Mon Sep 17 00:00:00 2001
From: TrainDoctor <11465594+TrainDoctor@users.noreply.github.com>
Date: Tue, 14 Jun 2022 13:38:29 -0700
Subject: Add README, tasks, moved to pnpm and added an ignore for react (#3)

---
 README.md | 37 +++++++++++++++++++++++++++++++++++++
 1 file changed, 37 insertions(+)
 create mode 100644 README.md

(limited to 'README.md')

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..04401c8
--- /dev/null
+++ b/README.md
@@ -0,0 +1,37 @@
+# React-Frontend Plugin Template 
+
+Reference example for using [decky-frontend-lib](https://github.com/SteamDeckHomebrew/decky-frontend-lib) in a [PluginLoader](https://github.com/SteamDeckHomebrew/PluginLoader) plugin.
+
+## PluginLoader Discord [![Chat](https://img.shields.io/badge/chat-on%20discord-7289da.svg)](https://discord.gg/ZU74G2NJzk)
+
+## Developers
+
+### Dependencies
+
+This template relies on the user having `pnpm` installed on their system.  
+This can be downloaded from `npm` itself which is recommended. 
+
+#### Linux
+
+```bash
+sudo npm i -g pnpm
+```
+
+### Getting Started
+
+1. Clone the repository to use as an example for making your plugin.
+2. In your clone of the repository run these commands:
+   1. ``pnpm i``
+   2. ``pnpm run build``
+3. You should do this every time you make changes to your plugin.
+
+Note: If you are recieveing build errors due to an out of date library, you should run this command inside of your repository:
+
+```bash
+pnpm update decky-frontend-lib --latest
+```
+
+### Distribution
+
+WIP. Check back in later.
+
-- 
cgit v1.2.3