Skip to content

Commit 25e5818

Browse files
committed
readme changes
1 parent 086bbbb commit 25e5818

File tree

2 files changed

+18
-8
lines changed

2 files changed

+18
-8
lines changed

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
/out-tsc
77

88
# dependencies
9-
/node_modules
9+
node_modules
1010

1111
# IDEs and editors
1212
/.idea

README.md

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,27 @@
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+
13
# ImageKit.io Angular SDK
24

35
[![Node CI](https://github.com/imagekit-developer/imagekit-angular/workflows/Node%20CI/badge.svg)](https://github.com/imagekit-developer/imagekit-angular/)
46
[![npm version](https://img.shields.io/npm/v/imagekitio-angular)](https://www.npmjs.com/package/imagekitio-angular)
57
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
68
[![Twitter Follow](https://img.shields.io/twitter/follow/imagekitio?label=Follow&style=social)](https://twitter.com/ImagekitIo)
79

8-
Angular SDK for [ImageKit.io](https://imagekit.io), which implements client-side upload and URL generation for use inside an angular application.
10+
ImageKit Angular SDK allows you to resize, optimize, deliver and upload images and videos in your react application.
911

10-
ImageKit is a complete image optimization and transformation solution that comes with an [image CDN](https://imagekit.io/features/imagekit-infrastructure) and media storage. It can be integrated with your existing infrastructure - storages like AWS S3, web servers, your CDN, and custom domain names, allowing you to deliver optimized images in minutes with minimal code changes.
12+
ImageKit is complete media storage, optimization, and transformation solution that comes with an image and video CDN. It can be integrated with your existing infrastructure - storage like AWS S3, web servers, your CDN, and custom domain names, allowing you to deliver optimized images in minutes with minimal code changes.
1113

1214
## Installation
1315

14-
`npm install --save imagekitio-angular`
16+
```shell
17+
npm install --save imagekitio-angular
18+
```
19+
20+
or
21+
22+
```shell
23+
yarn add imagekitio-angular
24+
```
1525

1626
## Usage
1727

@@ -38,11 +48,11 @@ In order to use the SDK, you need to provide it with a few configuration paramet
3848
})
3949
```
4050

41-
`publicKey` and `urlEndpoint` are mandatory parameters for SDK initialization.
42-
`authenticationEndpoint` is essential if you want to use the SDK for client-side uploads.
43-
`transformationPosition` is optional. The default value for the parameter is `path`. Acceptable values are `path` & `query`
51+
* `urlEndpoint` is required to use the SDK. You can get URL-endpoint from your ImageKit dashboard - https://imagekit.io/dashboard/url-endpoints.
52+
* `publicKey` and `authenticationEndpoint` parameters are required if you want to use the SDK for client-side file upload. You can get `publicKey` from the developer section in your ImageKit dashboard - https://imagekit.io/dashboard/developer/api-keys.
53+
* `transformationPosition` is optional. The default value for the parameter is `path`. Acceptable values are `path` & `query`
4454

45-
_Note: Do not include your Private Key in any client-side code, including this SDK or its initialization. If you pass the `privateKey` parameter while initializing this SDK, it throws an error_
55+
> Note: Do not include your [private key](https://docs.imagekit.io/api-reference/api-introduction/api-keys#private-key) in any client-side code.
4656
4757
### Quick examples
4858

0 commit comments

Comments
 (0)