From 3aad7f08feb87d4a3656d69f423abc6e4b6c63e2 Mon Sep 17 00:00:00 2001 From: Caleb Evans Date: Tue, 11 Jun 2024 16:30:53 -0700 Subject: [PATCH] Add more missing pieces to README --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f8af56c..89ec959 100644 --- a/README.md +++ b/README.md @@ -3,12 +3,20 @@ _Copyright 2017-2024, Caleb Evans_ _Released under the MIT license_ -jCanvas is a jQuery plugin that makes the HTML5 canvas easy to work with. +jCanvas is a jQuery plugin that makes the HTML5 canvas easy to work with. For more details on what it can do, [visit the website](https://projects.calebevans.me/jcanvas/). ## [Download](https://projects.calebevans.me/jcanvas/downloads/) jCanvas requires jQuery 1.9 or newer, and supports both desktop and mobile browsers. +If you are using a build pipeline, you can install jCanvas like so: + +```sh +npm install jquery +npm install jcanvas +npm install -D @types/jquery # Only needed for TypeScript +``` + ## [Documentation](https://projects.calebevans.me/jcanvas/docs/) Please search the online documentation before emailing me any questions you may have. If something in the documentation isn't clear, feel free to [email me](mailto:caleb@calebevans.me) for clarification.