Skip to content

Commit 047804a

Browse files
authored
Docs: Fixing terms used for attributes
1 parent d91972c commit 047804a

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ In order to use the SDK, you need to provide it with a few configuration paramet
5050

5151
`publicKey` and `urlEndpoint` are mandatory parameters for SDK initialization.
5252
`authenticationEndpoint` is essential if you want to use the SDK for client-side uploads.
53-
`transformationPosition` is optional. The default value for the parametere is `path`. Acceptable values are `path` & `query`
53+
`transformationPosition` is optional. The default value for the parameter is `path`. Acceptable values are `path` & `query`
5454

5555
_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_
5656

@@ -172,7 +172,7 @@ The component tries to keep the it simple, it loads a lower quality image using
172172

173173
## File Upload
174174
#### ik-upload
175-
The SDK provides a simple Component to upload files to the ImageKit Media Library. It accepts `fileName` parameter as a prop. The file parameter is provided as an input from the user.
175+
The SDK provides a simple Component to upload files to the ImageKit Media Library. It has an attribute called `fileName` which is used by SDK for `fileName` parameter required to upload. The `file` parameter is provided as an input from the user.
176176

177177
Also make sure that you have specified `authenticationEndpoint` during SDK initialization. The SDK makes an HTTP GET request to this endpoint and expects a JSON response with three fields i.e. `signature`, `token` and `expire`.
178178

@@ -185,4 +185,4 @@ Sample Usage
185185
<ik-upload fileName="my-upload" /></ik-upload>
186186
```
187187

188-
`ik-upload` component accepts all the parameters supported by the [ImageKit Upload API](https://docs.imagekit.io/api-reference/upload-file-api/client-side-file-upload#request-structure-multipart-form-data) as props e.g. `tags`, `useUniqueFileName`, `folder`, `isPrivateFile`, `customCoordinates` etc.
188+
`ik-upload` component accepts all the parameters supported by the [ImageKit Upload API](https://docs.imagekit.io/api-reference/upload-file-api/client-side-file-upload#request-structure-multipart-form-data) as attributes e.g. `tags`, `useUniqueFileName`, `folder`, `isPrivateFile`, `customCoordinates` etc.

0 commit comments

Comments
 (0)