Skip to content

Commit d8b5bd7

Browse files
committed
Fix README.md formatting and add more detailed project information
1 parent edb3cd2 commit d8b5bd7

1 file changed

Lines changed: 37 additions & 0 deletions

File tree

README.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Video-Games-DB
22

3+
An Angular application for browsing video games using the RAWG Video Games Database API.
4+
35
This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 16.2.2.
46

57
## Setup
@@ -45,3 +47,38 @@ Run `ng e2e` to execute the end-to-end tests via a platform of your choice. To u
4547
## Further help
4648

4749
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.
50+
51+
## Features
52+
53+
- Browse video games from RAWG database
54+
- Search functionality
55+
- Game details view
56+
- Responsive design with Angular Material
57+
58+
## Technologies Used
59+
60+
- Angular 16
61+
- Angular Material
62+
- RxJS
63+
- TypeScript
64+
- SCSS
65+
66+
## Code scaffolding
67+
68+
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`.
69+
70+
## Build
71+
72+
Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory.
73+
74+
## Running unit tests
75+
76+
Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io).
77+
78+
## Running end-to-end tests
79+
80+
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.
81+
82+
## Further help
83+
84+
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.

0 commit comments

Comments
 (0)