diff --git a/.gitignore b/.gitignore index 63c7efb..f62f79c 100644 --- a/.gitignore +++ b/.gitignore @@ -1,6 +1,7 @@ .DS_Store build dist +cdn node_modules # Logs diff --git a/README.md b/README.md index f36196c..2487dac 100644 --- a/README.md +++ b/README.md @@ -17,26 +17,34 @@ why? ## Installation -```bash -$ npm install lit-line +You can load our `lit-line` components via CDN: + +```html + ``` -or +or by installing it locally using package manager such as NPM: -```html - +```sh +npm i lit-line@latest ``` +Once installed, you only have to import the desired component and you are good to go. + +```js +import "lit-line"; +``` + +:::tip[About version management] +It is not recommended to use the `@latest` suffix, as a major release could break your application. Instead, use a fixed version such as `0.3.0`. +::: + ## quick start ```javascript