From 6bd34c6f785ed14248c9255d32ee02dad39194bc Mon Sep 17 00:00:00 2001 From: GHOST Date: Sat, 7 Sep 2024 01:48:17 +0100 Subject: [PATCH] docs: update package docs --- packages/svelte-cloudinary/README.md | 123 ++++++--------------------- 1 file changed, 27 insertions(+), 96 deletions(-) diff --git a/packages/svelte-cloudinary/README.md b/packages/svelte-cloudinary/README.md index e6e7c70c..73a1a6a4 100644 --- a/packages/svelte-cloudinary/README.md +++ b/packages/svelte-cloudinary/README.md @@ -10,141 +10,72 @@ Svelte -###### +--- - -GitHub Workflow Status npm GitHub +
# Svelte Cloudinary -High-performance image delivery and uploading at scale in Svelte powered by Cloudinary. +High-performance image delivery and uploading at scale in Svelte powered by Cloudinary. This is a community library supported by the Cloudinary Developer Experience team. -Features • Getting Started • Community & Support • Contributing - -**This is a community library supported by the Cloudinary Developer Experience team.** +[![tests status](https://img.shields.io/github/actions/workflow/status/cloudinary-community/svelte-cloudinary/tests.yml?label=Tests&style=for-the-badge)](https://github.com/cloudinary-community/svelte-cloudinary/actions/workflows/tests.yml) +[![svelte-cloudinary version](https://img.shields.io/npm/v/svelte-cloudinary?style=for-the-badge)](https://www.npmjs.com/package/svelte-cloudinary) +[![svelte-cloudinary MIT license](https://img.shields.io/github/license/cloudinary-community/svelte-cloudinary?label=License&style=for-the-badge)](https://github.com/cloudinary-community/svelte-cloudinary/blob/main/LICENSE) ## ✨ Features -- Automatically optimize images and deliver in modern formats -- Remove backgrounds from images -- Dynamically add image and text overlays to images -- AI-based cropping and resizing -- Transform images using color and effects -- Generate Open Graph Social Media cards on the fly -- ...all at scale with Cloudinary +- Automatically optimize images and deliver in modern formats +- Remove backgrounds from images +- Dynamically add image and text overlays to images +- AI-based cropping and resizing +- Transform images using color and effects +- Generate Open Graph Social Media cards on the fly +- ...all at scale with Cloudinary ## 🚀 Getting Started ### Installation -- Install `svelte-cloudinary` with: +- Install `svelte-cloudinary` with: ```bash npm install svelte-cloudinary ``` -- Add an environment variable with your Cloud Name: +- Add an environment variable with your Cloud Name: ```bash -VITE_PUBLIC_CLOUDINARY_CLOUD_NAME="" +VITE_CLOUDINARY_CLOUD_NAME="" ``` ### Adding an Image ```svelte - + ``` +## 📘 Docs + +https://svelte.cloudinary.dev + [Learn more about CldImage on the Svelte Cloudinary Docs](https://svelte-cloudinary.vercel.app/components/cldimage/basic-usage) ## ❤️ Community & Support -- [GitHub: Create an Issue](https://github.com/cloudinary-community/svelte-cloudinary/issues/new) -- [Twitter: @matiasfha](https://twitter.com/matiasfha) +- [GitHub: Create an Issue](https://github.com/cloudinary-community/svelte-cloudinary/issues/new) ## 🛠 Contributing Please read [CONTRIBUTING.md](https://github.com/cloudinary-community/svelte-cloudinary/blob/main/CONTRIBUTING.md) prior to contributing. -### Working Locally - -#### Installation - -This project is currently using [pnpm](https:///pnpm.io) as a way to manage dependencies and workspaces. - -With the project cloned, install the dependencies from the root of the project with: - -``` -pnpm install -``` - -#### Configuration - -To work on the project, you need to have an active Cloudinary account. With the account, configure a `.env.local` file inside of `docs` with: - -``` -VITE_PUBLIC_CLOUDINARY_CLOUD_NAME="" -VITE_PUBLIC_CLOUDINARY_API_KEY="" -CLOUDINARY_API_SECRET="" - -# The following are used for the internal playground not the library -PUBLIC_CLOUDINARY_UNSIGNED_UPLOAD_PRESET="" -PUBLIC_CLOUDINARY_SIGNED_UPLOAD_PRESET="" - -``` - -> Note: The Cloudinary account can be free, but some features may not work beyond free tier like Background Removal - -The Cloud Name is required for all usage, where the API Key and Secret currently is only used for Upload Widget usage. The Upload Preset is additionally used for the Upload Widgets. - -#### Uploading Example Images - -In order to run the Docs project, you need to have the images referenced available inside of your Cloudinary account. - -To do this, navigate to the `scripts` directory and first create a new `.env` file with: - -``` -CLOUDINARY_CLOUD_NAME="" -CLOUDINARY_API_KEY="" -CLOUDINARY_API_SECRET="" -``` - -Then run the upload script with: - -``` -pnpm upload -``` - -By default, the images inside of `scripts/images.json` will be uploaded to the "images" directory inside of your Cloudinary account. To change the location, add the `VITE_CLOUDINARY_IMAGES_DIRECTORY` environment variable with your preferred directory: - -``` -VITE_CLOUDINARY_IMAGES_DIRECTORY="" -``` - -#### Running the Project - -Once installed and configured, open two terminal tabs, navigating one to `svelte-cloudinary` and one to `docs`, running the following command in each: - -``` -pnpm dev -``` - -The project will now be available at or the configured local port. - -### Running Tests - -All tests are located inside of `svelte-cloudinary/svelte-cloudinary` each test lives along side the corresponding component. - -While inside `svelte-cloudinary`, run tests with: - -``` -pnpm test:unit -``` - ## Acknowledgement Thanks [cupcakearmy](https://github.com/cupcakearmy) for handing off the original [svelte-cloudinary](https://github.com/cupcakearmy/svelte-cloudinary) to allow us to continue on the work for the Svelte community!