Skip to content

Commit 010e9a0

Browse files
committed
docs: update README with quick demo references and remove outdated instructions
1 parent 02751f3 commit 010e9a0

File tree

2 files changed

+5
-11
lines changed

2 files changed

+5
-11
lines changed

README.md

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -338,17 +338,9 @@ imagekit.upload({
338338

339339
## Demo Application
340340

341-
For the fastest way to get started, check out the demo application in the [samples/sample-app](https://github.com/imagekit-developer/imagekit-javascript/tree/master/samples/sample-app) folder.
342-
343-
To run the demo locally:
344-
```bash
345-
git clone https://github.com/imagekit-developer/imagekit-javascript.git
346-
cd imagekit-javascript
347-
```
348-
Then, create a `.env` file in the `samples/sample-app` directory based on `sample.env` and provide your `PRIVATE_KEY`, `PUBLIC_KEY`, and `URL_ENDPOINT` from your ImageKit dashboard. Finally, start the demo:
349-
```bash
350-
yarn startSampleApp
351-
```
341+
For a quick demonstration of the SDK features, refer to our test examples:
342+
- URL Generation examples can be found in [test/url-generation.js](./test/url-generation.js)
343+
- File Upload examples can be found in [test/upload.js](./test/upload.js)
352344

353345
## Changelog
354346

test/url-generation.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -867,6 +867,7 @@ describe("URL generation", function () {
867867
expect(url).equal(`https://ik.imagekit.io/test_url_endpoint/tr:yc-40/test_path1.jpg`);
868868
});
869869

870+
// This is done just to test how SDK constructs URL, the actual transformation is not valid.
870871
it('Including deprecated properties', function () {
871872
const url = imagekit.url({
872873
path: "/test_path.jpg",
@@ -906,6 +907,7 @@ describe("URL generation", function () {
906907
expect(url).equal(`https://ik.imagekit.io/test_url_endpoint/tr:h-300,w-400,ar-4-3,q-40,c-force,cm-extract,fo-left,f-jpeg,r-50,bg-A94D34,b-5-A94D34,rt-90,bl-10,n-some_name,pr-true,lo-true,t-5,md-true,cp-true,di-folder@@file.jpg,dpr-3,e-sharpen-10,e-usm-2-2-0.8-0.024,e-contrast,e-grayscale,e-shadow-bl-15_st-40_x-10_y-N5,e-gradient-from-red_to-white,orig-true,h-200,w-300,l-image,i-logo.png,l-end/test_path.jpg`);
907908
});
908909

910+
// This is done just to test how SDK constructs URL, the actual transformation is not valid
909911
it('should generate the correct URL when comprehensive transformations, including video and AI transformations, are applied', function () {
910912
const url = imagekit.url({
911913
path: "/test_path.jpg",

0 commit comments

Comments
 (0)