Skip to content

Commit a1779f5

Browse files
committed
docs: Update overview
1 parent 754f9b1 commit a1779f5

File tree

5 files changed

+40
-76
lines changed

5 files changed

+40
-76
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ For complete pricing and details visit our [Chat Pricing Page](https://getstream
3535
### Install with NPM
3636

3737
```
38-
npm install npm install stream-chat-angular stream-chat-css stream-chat @ngx-translate/core
38+
npm install stream-chat-angular stream-chat-css stream-chat @ngx-translate/core
3939
```
4040

4141
## Sample App

docusaurus/docs/Angular/basics/getting-started.mdx

Lines changed: 0 additions & 58 deletions
This file was deleted.

docusaurus/docs/Angular/basics/installation.mdx

Lines changed: 0 additions & 16 deletions
This file was deleted.
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
id: overview
3+
sidebar_position: 1
4+
slug: /
5+
title: Overview
6+
---
7+
8+
Building on top of the Stream Chat API, the Stream Chat Angular component library includes everything you need to build feature-rich and high-functioning chat user experiences out of the box.
9+
The library includes an extensive set of performant and customizable Angular components which allow you to get started quickly with little to no plumbing required.
10+
Use cases include team and social messaging and customer support. The library supports:
11+
12+
- Rich media messages
13+
- Reactions
14+
- Image and file uploads
15+
- Read state
16+
- Channel and message lists
17+
18+
## Architecture
19+
20+
The library contains a set of components that contain all of the necessary features to build a performant chat UI. However, it is also possible to provide your own custom components instead of the built-in ones.
21+
22+
If you want to, you can build your own chat UI from scratch but still take advantage of the library by using our services.
23+
24+
The left navigation will guide you to the various documentation sections for information on everything regarding our robust component library. Check out the instructions below for adding the library to your Angular project.
25+
26+
## Installation
27+
28+
We recommended using the component library through a package manager. Stream Chat React is based on top of Stream's [JavaScript Client](https://getstream.io/chat/docs/javascript/?language=javascript).
29+
30+
### Install with NPM
31+
32+
```bash
33+
npm install stream-chat-angular stream-chat-css stream-chat @ngx-translate/core
34+
```
35+
36+
## Tutorial
37+
38+
Follow our [tutorial](https://getstream.io/tutorials/angular-chat/) and build your first Stream Angular chat application.

projects/stream-chat-angular/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ For complete pricing and details visit our [Chat Pricing Page](https://getstream
3535
### Install with NPM
3636

3737
```
38-
npm install npm install stream-chat-angular stream-chat-css stream-chat @ngx-translate/core
38+
npm install stream-chat-angular stream-chat-css stream-chat @ngx-translate/core
3939
```
4040

4141
## Sample App

0 commit comments

Comments
 (0)