Skip to content

Commit 85def5a

Browse files
committed
chore: Update READMEs
1 parent f0c899b commit 85def5a

File tree

2 files changed

+10
-38
lines changed

2 files changed

+10
-38
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -115,10 +115,10 @@ The SDK supports both **module-based** and **standalone** Angular applications.
115115

116116
#### Module-based Applications
117117

118-
To use the SDK in a module-based app, import `ImagekitioAngularModule` in your `app.module.ts`:
118+
To use the SDK in a module-based app, import `ImagekitAngularModule` in your `app.module.ts`:
119119

120120
```typescript
121-
import { ImagekitioAngularModule } from '@imagekit/angular';
121+
import { ImagekitAngularModule } from '@imagekit/angular';
122122

123123
@NgModule({
124124
declarations: [
@@ -127,7 +127,7 @@ import { ImagekitioAngularModule } from '@imagekit/angular';
127127
imports: [
128128
BrowserModule,
129129
AppRoutingModule,
130-
ImagekitioAngularModule.forRoot({
130+
ImagekitAngularModule.forRoot({
131131
urlEndpoint: environment.urlEndpoint,
132132
})
133133
],
@@ -511,11 +511,11 @@ For client-side file uploads, you need to implement an `authenticator` function
511511

512512
```typescript
513513
// app.module.ts
514-
import { ImagekitioAngularModule } from '@imagekit/angular';
514+
import { ImagekitAngularModule } from '@imagekit/angular';
515515

516516
@NgModule({
517517
imports: [
518-
ImagekitioAngularModule.forRoot({
518+
ImagekitAngularModule.forRoot({
519519
urlEndpoint: environment.urlEndpoint,
520520
})
521521
]

test-app/README.md

Lines changed: 5 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -23,15 +23,8 @@ npm install
2323
Open `src/app/app.module.ts` and update the ImageKit configuration with your credentials:
2424

2525
```typescript
26-
ImagekitioAngularModule.forRoot({
27-
publicKey: 'your_public_key_here',
26+
ImagekitAngularModule.forRoot({
2827
urlEndpoint: 'https://ik.imagekit.io/your_imagekit_id',
29-
authenticator: async () => {
30-
// Replace with your backend authentication endpoint
31-
const response = await fetch('http://localhost:3000/auth');
32-
const data = await response.json();
33-
return { signature: data.signature, expire: data.expire, token: data.token };
34-
}
3528
})
3629
```
3730

@@ -53,9 +46,7 @@ const app = express();
5346
app.use(cors());
5447

5548
const imagekit = new ImageKit({
56-
publicKey: 'your_public_key',
5749
privateKey: 'your_private_key',
58-
urlEndpoint: 'https://ik.imagekit.io/your_imagekit_id'
5950
});
6051

6152
app.get('/auth', (req, res) => {
@@ -88,7 +79,6 @@ This demo app showcases the following ImageKit Angular SDK features:
8879

8980
1. **Basic Image Rendering** - Simple image display with transformations
9081
2. **Lazy Loading** - Images that load only when they enter the viewport
91-
3. **LQIP (Low Quality Image Placeholder)** - Progressive image loading with blur effect
9282
4. **Responsive Images** - Automatic srcset generation for different screen sizes
9383
5. **Chained Transformations** - Multiple transformations applied in sequence
9484
6. **Video Component** - Video rendering with transformations
@@ -136,7 +126,7 @@ async uploadFile(file: File) {
136126
const result = await upload({
137127
file: file,
138128
fileName: file.name,
139-
publicKey: 'your_public_key',
129+
publicKey: authData.publicKey,
140130
signature: authData.signature,
141131
expire: authData.expire,
142132
token: authData.token,
@@ -172,32 +162,14 @@ Common transformations you can apply:
172162

173163
If you make changes to the SDK and want to test them:
174164

175-
1. Navigate to the SDK directory:
176-
```bash
177-
cd ../sdk
178-
```
165+
1. Make changes in the sdk
179166

180-
2. Build the SDK:
181-
```bash
182-
npm run build
183-
```
184-
185-
3. Create a tarball from the dist directory:
186-
```bash
187-
cd dist/imagekit-angular
188-
npm pack
189-
```
190-
191-
4. Install the updated package in the test app:
192-
```bash
193-
cd ../../../test-app
194-
npm install ../sdk/dist/imagekit-angular/imagekit-angular-6.0.0.tgz
195-
```
167+
2. Run `./install_sdk.sh`
196168

197169
## Running Tests
198170

199171
```bash
200-
npm test
172+
npm run e2e
201173
```
202174

203175
## Building for Production

0 commit comments

Comments
 (0)