Skip to content

Commit ac36fee

Browse files
committed
Enhance CI workflow and add README with SDK details and installation instructions
1 parent b4c332c commit ac36fee

File tree

3 files changed

+60
-4
lines changed

3 files changed

+60
-4
lines changed

.github/workflows/publish.yml

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,17 @@ jobs:
1111
contents: read
1212
id-token: write
1313
steps:
14-
- uses: actions/checkout@v4
15-
# Setup .npmrc file to publish to npm
16-
- uses: actions/setup-node@v4
14+
- name: ⬇️ Check out code
15+
uses: actions/checkout@v4
16+
17+
- name: Setup .npmrc file to publish to npm
18+
uses: actions/setup-node@v4
1719
with:
1820
node-version: '20.x'
1921
registry-url: 'https://registry.npmjs.org'
20-
- run: |
22+
23+
- name: Build and Publish
24+
run: |
2125
npm ci
2226
npm run build
2327
# print the NPM user name for validation

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2020 Imagekit
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
[<img width="250" alt="ImageKit.io" src="https://raw.githubusercontent.com/imagekit-developer/imagekit-javascript/master/assets/imagekit-light-logo.svg"/>](https://imagekit.io)
2+
3+
# ImageKit.io Vue.js SDK
4+
5+
![Node CI](https://github.com/imagekit-developer/imagekit-vuejs/workflows/Node%20CI/badge.svg)
6+
[![npm version](https://img.shields.io/npm/v/@imagekit/vue)](https://www.npmjs.com/package/@imagekit/vue)
7+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
8+
[![Twitter Follow](https://img.shields.io/twitter/follow/imagekitio?label=Follow&style=social)](https://twitter.com/ImagekitIo)
9+
10+
## Introduction
11+
12+
ImageKit Vue.js SDK provides a simple way to integrate ImageKit.io with your Vue.js/Nuxt applications. It allows you to easily:
13+
- Render images and video with automatic optimization and responsive sizes.
14+
- Apply transformations to images and videos using URL parameters.
15+
- Apply powerful AI-powered image transformations e.g. background removal, generative fill, object cropping, and more.
16+
17+
## Installation
18+
19+
You can install the SDK in your project using npm or yarn.
20+
21+
```bash
22+
npm install @imagekit/vue
23+
```
24+
25+
## TypeScript support
26+
27+
The SDK provides first-class TypeScript support for Vue projects, giving you robust type-safety and IDE IntelliSense out of the box—no extra configuration required for your Vue + TypeScript apps.
28+
29+
## Documentation
30+
31+
Refer to the ImageKit [official documentation](https://imagekit.io/docs/integration/vuejs) for more details on how to use the SDK.

0 commit comments

Comments
 (0)