Skip to content

Commit 47b79e6

Browse files
committed
Added: add run example documentation
1 parent 387d3ef commit 47b79e6

File tree

1 file changed

+23
-24
lines changed

1 file changed

+23
-24
lines changed

README.md

Lines changed: 23 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -21,31 +21,30 @@ import { NgxStringly } from '@rizentium/ngx-stringly';
2121
```
2222
Use `NgxStringly` in your functions
2323
```typescript
24-
const text = 'The quick brown fox jumps over the lazy dog';
24+
const text = 'The quick brown fox jumps over the lazy dog.';
2525
const find = 'lazy';
2626

2727
this.result = NgxStringly.parsing(text, find, false);
2828
```
29-
## Development server
30-
31-
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.
32-
33-
## Code scaffolding
34-
35-
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`.
36-
37-
## Build
38-
39-
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.
40-
41-
## Running unit tests
42-
43-
Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io).
44-
45-
## Running end-to-end tests
46-
47-
Run `ng e2e` to execute the end-to-end tests via [Protractor](http://www.protractortest.org/).
48-
49-
## Further help
50-
51-
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).
29+
Result will be
30+
```json
31+
{
32+
"prefix": "The quick brown fox jumps over the ",
33+
"content": "lazy",
34+
"suffix": " dog."
35+
}
36+
```
37+
## Run Example
38+
Clone the repository
39+
```bash
40+
git clone https://github.com/rizentium/ngx-stringly.git
41+
```
42+
Open `ngx-stringly` directory
43+
```bash
44+
cd ngx-stringly
45+
```
46+
Run server
47+
```bash
48+
ng serve
49+
```
50+
And navigate your browser to `http://localhost:4200`

0 commit comments

Comments
 (0)