From 31c407d0a9015c016081029f3c6cb1faaf05fe53 Mon Sep 17 00:00:00 2001 From: Adam Graham Date: Tue, 19 Nov 2024 04:44:05 -0600 Subject: [PATCH] Update README with better install instructions --- README.md | 41 +++++++++++++++++------------------------ 1 file changed, 17 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index b603194..e4532fa 100644 --- a/README.md +++ b/README.md @@ -8,41 +8,34 @@ The official React implementation of the Forge design system created by [@ziguro ## Installation -### NPM - -Set the scoped package registry in your `.npmrc` file: -```bash -registry=https://registry.npmjs.org/ -@zigurous:registry=https://npm.pkg.github.com -``` - -Run one of the following commands in a terminal: -- Install with npm `npm install @zigurous/forge-react` -- Install with yarn `yarn add @zigurous/forge-react` -- Install with pnpm `pnpm add @zigurous/forge-react` - ### CDN -Add one of the following links to your HTML: - -#### CloudFront +Available from any of the following: +- Install with CloudFront `https://cdn.zigurous.com/forge-react@1.0.0/dist/index.min.js` +- Install with jsDelivr `https://cdn.jsdelivr.net/gh/zigurous/forge-react@1.0.0/dist/index.min.js` +- Install with Statically `https://cdn.statically.io/gh/zigurous/forge-react/1.0.0/dist/index.min.js` +Add the script in your HTML file: ```html