diff --git a/README.md b/README.md new file mode 100644 index 0000000..a80b6c3 --- /dev/null +++ b/README.md @@ -0,0 +1,83 @@ +# svelte-cloudinary + +This is a little library that aims at integrating and making it easier to use the svelte with [Cloudinary](https://cloudinary.com/). +There is an official integration comming, but it's not ready and for not does not work great. + +## 🚀 Quickstart + +```bash +yarn add svelte-cloudinary +``` + +```svelte + + + + +background +``` + +This will formulate the Cloudinary url and insert it into the `img.src` property. +Also it will resize to the `img` object itself because we set `bind: true`. + +## 🗂 Docs + +The `image` action takes 3 parameters. + +### `src` + +The `publicId` of your asset. + +### `bind` + +This is a utility for setting width and/or height automatically based on the size of a rendered element in the DOM. + +- `true`: Uses the size of the img node itself +- `'.someClass'`: Searches for the element closest to the image that matches the css query and takes that as size +- `{ height: document.querySelector('#some'), height: '#some' }`: Set height and/or width independently from another. Can be an element or css selector. + +###### Examples + +```svelte + + +``` + +```svelte + +
+
+``` + +```svelte + +
+
+``` + +### `options` + +Native cloudinary options. See [here for official docs](https://cloudinary.com/documentation/image_transformations) +For a quick glance