Skip to content

Commit 6f43cfb

Browse files
violetviolinistvioletviolinist
committed
rewrite readmes for sample apps
1 parent 87b978c commit 6f43cfb

File tree

6 files changed

+48
-126
lines changed

6 files changed

+48
-126
lines changed

‎samples/imagekitio-angular4-sample/README.md

Lines changed: 8 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,14 @@
1-
# Angular4app
1+
# Imagekit Angular 4 Sample
22

3-
This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 1.4.10.
3+
This project shows the usage of ImageKit Angular SDK in an Angular 4 app. Please note that you need to have `@angular/cli v1.4.10` installed to run this application. You can install that version locally by running this command in the folder for this sample application:
44

5-
## Development server
65

7-
Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.
6+
```sh
7+
> npm install
8+
```
89

9-
## Code scaffolding
10+
## Running the application
1011

11-
Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`.
12+
Before you can use Imagekit SDK, you need to provide config values required in `app.module.ts` and `app.component.ts`. You can either configure your environment and take values from there, or directly provide in respective files.
1213

13-
## Build
14-
15-
Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory. Use the `-prod` flag for a production build.
16-
17-
## Running unit tests
18-
19-
Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io).
20-
21-
## Running end-to-end tests
22-
23-
Run `ng e2e` to execute the end-to-end tests via [Protractor](http://www.protractortest.org/).
24-
25-
## Further help
26-
27-
To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI README](https://github.com/angular/angular-cli/blob/master/README.md).
14+
To start the application, use `npm start` command.

‎samples/imagekitio-angular5-sample/README.md

Lines changed: 8 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,14 @@
1-
# Angular5app
1+
# Imagekit Angular 5 Sample
22

3-
This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 1.7.4.
3+
This project shows the usage of ImageKit Angular SDK in an Angular 5 app. Please note that you need to have `@angular/cli v1.7.4` installed to run this application. You can install that version locally by running this command in the folder for this sample application:
44

5-
## Development server
65

7-
Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.
6+
```sh
7+
> npm install
8+
```
89

9-
## Code scaffolding
10+
## Running the application
1011

11-
Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`.
12+
Before you can use Imagekit SDK, you need to provide config values required in `app.module.ts` and `app.component.ts`. You can either configure your environment and take values from there, or directly provide in respective files.
1213

13-
## Build
14-
15-
Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory. Use the `-prod` flag for a production build.
16-
17-
## Running unit tests
18-
19-
Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io).
20-
21-
## Running end-to-end tests
22-
23-
Run `ng e2e` to execute the end-to-end tests via [Protractor](http://www.protractortest.org/).
24-
25-
## Further help
26-
27-
To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI README](https://github.com/angular/angular-cli/blob/master/README.md).
14+
To start the application, use `npm start` command.

‎samples/imagekitio-angular6-sample/README.md

Lines changed: 8 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,14 @@
1-
# Angular6app
1+
# Imagekit Angular 6 Sample
22

3-
This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 6.2.9.
3+
This project shows the usage of ImageKit Angular SDK in an Angular 6 app. Please note that you need to have `@angular/cli v6.*.*` installed to run this application. You can install that version locally by running this command in the folder for this sample application:
44

5-
## Development server
65

7-
Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.
6+
```sh
7+
> npm install
8+
```
89

9-
## Code scaffolding
10+
## Running the application
1011

11-
Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`.
12+
Before you can use Imagekit SDK, you need to provide config values required in `app.module.ts` and `app.component.ts`. You can either configure your environment and take values from there, or directly provide in respective files.
1213

13-
## Build
14-
15-
Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory. Use the `--prod` flag for a production build.
16-
17-
## Running unit tests
18-
19-
Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io).
20-
21-
## Running end-to-end tests
22-
23-
Run `ng e2e` to execute the end-to-end tests via [Protractor](http://www.protractortest.org/).
24-
25-
## Further help
26-
27-
To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI README](https://github.com/angular/angular-cli/blob/master/README.md).
14+
To start the application, use `npm start` command.

‎samples/imagekitio-angular7-sample/README.md

Lines changed: 8 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,14 @@
1-
# Angular8app
1+
# Imagekit Angular 7 Sample
22

3-
This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 7.3.9.
3+
This project shows the usage of ImageKit Angular SDK in an Angular 7 app. Please note that you need to have `@angular/cli v7.*.*` installed to run this application. You can install that version locally by running this command in the folder for this sample application:
44

5-
## Development server
65

7-
Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.
6+
```sh
7+
> npm install
8+
```
89

9-
## Code scaffolding
10+
## Running the application
1011

11-
Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`.
12+
Before you can use Imagekit SDK, you need to provide config values required in `app.module.ts` and `app.component.ts`. You can either configure your environment and take values from there, or directly provide in respective files.
1213

13-
## Build
14-
15-
Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory. Use the `--prod` flag for a production build.
16-
17-
## Running unit tests
18-
19-
Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io).
20-
21-
## Running end-to-end tests
22-
23-
Run `ng e2e` to execute the end-to-end tests via [Protractor](http://www.protractortest.org/).
24-
25-
## Further help
26-
27-
To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI README](https://github.com/angular/angular-cli/blob/master/README.md).
14+
To start the application, use `npm start` command.

‎samples/imagekitio-angular8-sample/README.md

Lines changed: 8 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,14 @@
1-
# Angular8app
1+
# Imagekit Angular 8 Sample
22

3-
This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 8.3.25.
3+
This project shows the usage of ImageKit Angular SDK in an Angular 8 app. Please note that you need to have `@angular/cli v8.*.*` installed to run this application. You can install that version locally by running this command in the folder for this sample application:
44

5-
## Development server
65

7-
Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.
6+
```sh
7+
> npm install
8+
```
89

9-
## Code scaffolding
10+
## Running the application
1011

11-
Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`.
12+
Before you can use Imagekit SDK, you need to provide config values required in `app.module.ts` and `app.component.ts`. You can either configure your environment and take values from there, or directly provide in respective files.
1213

13-
## Build
14-
15-
Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory. Use the `--prod` flag for a production build.
16-
17-
## Running unit tests
18-
19-
Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io).
20-
21-
## Running end-to-end tests
22-
23-
Run `ng e2e` to execute the end-to-end tests via [Protractor](http://www.protractortest.org/).
24-
25-
## Further help
26-
27-
To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI README](https://github.com/angular/angular-cli/blob/master/README.md).
14+
To start the application, use `npm start` command.

‎samples/imagekitio-angular9-sample/README.md

Lines changed: 8 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,14 @@
1-
# Angular9app
1+
# Imagekit Angular 9 Sample
22

3-
This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 9.1.8.
3+
This project shows the usage of ImageKit Angular SDK in an Angular 9 app. Please note that you need to have `@angular/cli v9.*.*` installed to run this application. You can install that version locally by running this command in the folder for this sample application:
44

5-
## Development server
65

7-
Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.
6+
```sh
7+
> npm install
8+
```
89

9-
## Code scaffolding
10+
## Running the application
1011

11-
Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`.
12+
Before you can use Imagekit SDK, you need to provide config values required in `app.module.ts` and `app.component.ts`. You can either configure your environment and take values from there, or directly provide in respective files.
1213

13-
## Build
14-
15-
Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory. Use the `--prod` flag for a production build.
16-
17-
## Running unit tests
18-
19-
Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io).
20-
21-
## Running end-to-end tests
22-
23-
Run `ng e2e` to execute the end-to-end tests via [Protractor](http://www.protractortest.org/).
24-
25-
## Further help
26-
27-
To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI README](https://github.com/angular/angular-cli/blob/master/README.md).
14+
To start the application, use `npm start` command.

0 commit comments

Comments
 (0)