From 0c6fb870832557145e76af6f315ccb584938814b Mon Sep 17 00:00:00 2001 From: DPende Date: Wed, 24 Apr 2024 14:16:54 +0200 Subject: [PATCH] refactor: update readme --- README.md | 67 ++++++++++++++++++++++++++++--------------------------- 1 file changed, 34 insertions(+), 33 deletions(-) diff --git a/README.md b/README.md index 0e3b28b..2468eb5 100644 --- a/README.md +++ b/README.md @@ -23,9 +23,12 @@ A complete list of the available features is available [below](#Features). EditPix supports multiple different installation methods. + ### Usage in the browser +For use in the browser the library can be installed via [npm](#installing-from-npm) or loaded via [CDN](#loading-from-a-cdn). + -#### Installing from `npm` +### Installing from `npm` ```bash npm i editpix @@ -46,9 +49,6 @@ const editpix = new Editpix(); // use library ``` -
- - ### Loading from a CDN In your HTML file, load the script as a module: @@ -74,16 +74,17 @@ You can also choose the version of the library you prefer by specifying it in th import EditPix from 'https://cdn.jsdelivr.net/npm/editpix@[version]/+esm'; ``` +
### Usage in Vue.js -#### Installing from `npm` + Installing from `npm` ```bash npm i editpix ``` -### Import and use in your component +Import and use in your component: ```jsx