Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
tschellenbach authored Nov 27, 2019
1 parent 0dad335 commit 29daf74
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## React Chat Components
# React Chat Components

> The official React components for Stream Chat, a service for
> building chat applications.
Expand All @@ -22,11 +22,11 @@ With these chat components you can support any type of chat use case:
- Messaging style chat like Whatsapp or Facebook's messenger
- Commerce chat like Drift or Intercom

### React Native Chat Tutorial
## React Native Chat Tutorial

The best place to start is the [React Chat Tutorial](https://getstream.io/chat/react-chat/tutorial/). It teaches you how to use this SDK and also shows how to make common changes.

### Example Apps
## Example Apps

This repo includes 4 example apps. You can try them out like this:

Expand All @@ -40,19 +40,19 @@ yarn start

The 4 examples are `messaging`, `team`, `commerce` and `livestream`. You can also preview these demos online in the [Chat Demos](https://getstream.io/chat/demos/)

### Docs
## Docs

The [styleguidist docs for stream-chat-react](https://getstream.github.io/stream-chat-react/) document how all the components work.

The React components are created using the stream-chat-js library. If you're customizing the components it's important to learn how the Chat Server API works. You'll want to review our [JS chat API docs](https://getstream.io/chat/docs/js/).

### Commands
## Commands

- yarn docs-server
- yarn lint-fix
- yarn lint

### Component Reusability
## Component Reusability

1. If a component implements a ton of logic it's nice if you split it out into 2 Components
The top level component which handles all the logic, and a lower level component which just handles rendering.
Expand Down Expand Up @@ -81,7 +81,7 @@ The React components are created using the stream-chat-js library. If you're cus
- Make the changes you want in the scss files
- Run `yarn build-styles` or `yarn watch-styles`

### Performance
## Performance

Since chat can get pretty active it's important to pay attention to performance.
For every component either:
Expand Down Expand Up @@ -116,6 +116,6 @@ Common mistakes that hurt performance are:
- Mistake: Passing an object {} or an array [] that's not using seamless-immutable
- Solution: Use an immutable type (ie a number or a string) or use a seamless immutable version of an object or an array

### Contributing
## 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 very happy to merge your code in the official repository. 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.

0 comments on commit 29daf74

Please sign in to comment.