stream-chat-angular 3.0.0-beta.9 → 3.1.0

package/README.md

@@ -30,15 +30,38 @@ The best way to get started is to follow the [Angular Chat Tutorial](https://get
 Stream is free for most side and hobby projects. To qualify, your project/company must have no more than 5 team members and earn less than $10k in monthly revenue.
 For complete pricing and details visit our [Chat Pricing Page](https://getstream.io/chat/pricing/).
 
+## Docs
+
+The [docs](https://getstream.io/chat/docs/sdk/angular/) provide a brief description about the components and services in the library.
+
+The Angular library is created using the [stream-chat-js](https://github.com/getstream/stream-chat-js) library. For the most common use cases our services should give a nice abstraction over this library, however you might need it for more advanced customization, the [documentation](https://getstream.io/chat/docs/js/) is on our website.
+
+## Contributing
+
+We welcome code changes that improve this library or fix a problem. Please make sure to follow all best practices and add tests, if applicable, before submitting a pull request on GitHub. We are pleased to merge your code into the official repository if it meets a need. Make sure to sign our [Contributor License Agreement (CLA)](https://docs.google.com/forms/d/e/1FAIpQLScFKsKkAJI7mhCr7K9rEIOpqIDThrWxuvxnwUq2XkHyG154vQ/viewform) first. See our license file for more details.
+
+## We are hiring!
+
+We recently closed a [$38 million Series B funding round](https://techcrunch.com/2021/03/04/stream-raises-38m-as-its-chat-and-activity-feed-apis-power-communications-for-1b-users/) and are actively growing.
+Our APIs are used by more than a billion end-users, and by working at Stream, you have the chance to make a huge impact on a team of very strong engineers.
+
+Check out our current openings and apply via [Stream's website](https://getstream.io/team/#jobs).
+
 ## Installation
 
 ### Install with NPM
 
-```
-npm install stream-chat-angular @stream-io/stream-chat-css stream-chat @ngx-translate/core
+Run the following command if you are using **Angular 13**:
+
+```shell
+npm install stream-chat-angular stream-chat @ngx-translate/core
 ```
 
-**Important note** If you are using **Angular 12** you will need to add `--legacy-peer-deps` flag as `@ngx-translate/core`'s newest version only supports Angular 13.
+Run this command if you are using **Angular 12**:
+
+```shell
+npm install stream-chat-angular stream-chat@5 @ngx-translate/core --legacy-peer-deps
+```
 
 ## Sample App
 
@@ -56,19 +79,28 @@ STREAM_USER_TOKEN=<Your user token>
 
 Run `npm start` and navigate to `http://localhost:4200/`.
 
-## Docs
+## Customization examples
 
-The [docs](https://getstream.io/chat/docs/sdk/angular/) provide a brief description about the components and services in the library.
+This repository includes a sample app that showcases how you can provide your own template for different components within the SDK:
 
-The Angular library is created using the [stream-chat-js](https://github.com/getstream/stream-chat-js) library. For the most common use cases our services should give a nice abstraction over this library, however you might need it for more advanced customization, the [documentation](https://getstream.io/chat/docs/js/) is on our website.
+To run the app:
 
-## Contributing
+Create a file named `.env` in the root directory with the following content:
 
-We welcome code changes that improve this library or fix a problem. Please make sure to follow all best practices and add tests, if applicable, before submitting a pull request on GitHub. We are pleased to merge your code into the official repository if it meets a need. Make sure to sign our [Contributor License Agreement (CLA)](https://docs.google.com/forms/d/e/1FAIpQLScFKsKkAJI7mhCr7K9rEIOpqIDThrWxuvxnwUq2XkHyG154vQ/viewform) first. See our license file for more details.
+```
+STREAM_API_KEY=<Your API key>
+STREAM_USER_ID=<Your user ID>
+STREAM_USER_TOKEN=<Your user token>
+```
 
-## We are hiring!
+Run `npm start:customizations-example` and navigate to `http://localhost:4200/`.
 
-We recently closed a [$38 million Series B funding round](https://techcrunch.com/2021/03/04/stream-raises-38m-as-its-chat-and-activity-feed-apis-power-communications-for-1b-users/) and are actively growing.
-Our APIs are used by more than a billion end-users, and by working at Stream, you have the chance to make a huge impact on a team of very strong engineers.
+## Local development
 
-Check out our current openings and apply via [Stream's website](https://getstream.io/team/#jobs).
+Run `npm install` in the root of the project. You can use the `npm run start:dev` command to start the SampleApp with automatic reloading.
+
+A note about the documentation:
+
+- Documentations for Angular services are generated from doc comments in the source files (not under source control)
+- Documentations for inputs and outputs of Angular components are generated from doc comments in the source files (not under source control)
+- Everything else in the documentation is written in `mdx` files located in the `docusaurus` folder

package/assets/version.d.ts

@@ -1 +1 @@
-export declare const version = "3.0.0-beta.9";
+export declare const version = "3.1.0";