Skip to content

Commit 8ab35e2

Browse files
authored
Update README.md
1 parent f78dcf2 commit 8ab35e2

File tree

1 file changed

+13
-20
lines changed

1 file changed

+13
-20
lines changed

Diff for: README.md

+13-20
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,20 @@
1-
# AngularLayoutComponents
1+
# Angular Layout Components
22

3-
This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 17.3.6.
3+
Set of Angular Components for managing layout, inspired by [Bento DS Layout Components](https://developer.bento-ds.com/Guides/layout)
44

5-
## Development server
5+
## Usage
6+
Refer to https://buildo.github.io/angular-layout-components
67

7-
Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The application will automatically reload if you change any of the source files.
8+
## Contributing
89

9-
## Code scaffolding
10+
Install dependencies using
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+
```bash
13+
npm install
14+
```
1215

13-
## Build
16+
then run the Storybook using
1417

15-
Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory.
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 a platform of your choice. To use this command, you need to first add a package that implements end-to-end testing capabilities.
24-
25-
## Further help
26-
27-
To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI Overview and Command Reference](https://angular.io/cli) page.
18+
```bash
19+
npm run ng run layout-components:storybook
20+
```

0 commit comments

Comments
 (0)