Skip to content

Commit 749208f

Browse files
Make the readme useful.
1 parent f71260d commit 749208f

1 file changed

Lines changed: 74 additions & 16 deletions

File tree

README.md

Lines changed: 74 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,94 @@
1-
# stream-chat-css
1+
# Stream Chat CSS
22

3-
> Bundled CSS for Stream Chat SDKs
3+
<div align="center">
4+
<img src="https://getstream.io/images/logos/stream-logo-mark-color.svg" width="88" alt="Stream logo" />
5+
<h3>Beautiful, ready-to-use styling for Stream Chat SDKs</h3>
6+
7+
[![NPM](https://img.shields.io/npm/v/@stream-io/stream-chat-css.svg)](https://www.npmjs.com/package/@stream-io/stream-chat-css)
8+
[![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/GetStream/stream-chat-css/blob/main/LICENSE)
9+
[![Build Status](https://img.shields.io/github/workflow/status/GetStream/stream-chat-css/CI/main)](https://github.com/GetStream/stream-chat-css/actions)
10+
</div>
411

5-
[![NPM](https://img.shields.io/npm/v/@stream-io/stream-chat-css.svg)](https://www.npmjs.com/package/@stream-io/stream-chat-css)
12+
## 📝 Overview
613

7-
## Install
14+
Stream Chat CSS provides a comprehensive set of styles that power the UI components in [Stream](https://getstream.io/)'s Chat SDKs. This package is designed to make implementing beautiful, responsive chat interfaces straightforward and consistent.
15+
16+
- 🎨 **Complete Styling** - All the CSS you need to build full-featured chat applications
17+
- 🧩 **Component-Based** - Organized by UI component for easy customization
18+
- 🌈 **Themeable** - Extensive design system with customizable variables
19+
- 🌐 **Cross-Browser Support** - Works across all modern browsers and devices
20+
- 🧿 **Accessibility** - Built with a11y best practices
21+
22+
## 🚀 Installation
823

924
```bash
10-
# with npm
25+
# With npm
1126
npm install --save @stream-io/stream-chat-css
12-
# with yarn
27+
28+
# With yarn
1329
yarn add @stream-io/stream-chat-css
30+
31+
# With pnpm
32+
pnpm add @stream-io/stream-chat-css
1433
```
1534

16-
## Usage
35+
## 💻 Usage
36+
37+
This package comes as a dependency of `stream-chat-react` and doesn't require explicit installation if you're already using the React component library.
1738

18-
This repository comes as a dependency of `stream-chat-react` and doesn't require explicit installation if you're using the component library. Add the styles to your app by importing the bundled CSS:
39+
### Adding the styles to your app
40+
41+
Simply import the bundled CSS into your application:
1942

2043
```tsx
2144
import '@stream-io/stream-chat-css/dist/css/index.css';
2245
```
2346

24-
## License
47+
### Custom Theming
2548

26-
MIT © [Stream.io Inc.](https://getstream.io)
49+
Stream Chat CSS supports customization through CSS variables. You can override the default theme by setting your own values for the CSS variables.
50+
51+
```css
52+
:root {
53+
--str-chat__primary-color: #00b7ff;
54+
--str-chat__secondary-color: #1a1a1a;
55+
/* More customizations here */
56+
}
57+
```
58+
59+
## 🔍 Why Choose Stream?
2760

28-
## We are hiring!
61+
[Stream](https://getstream.io) powers chat and activity feeds for over 1 billion end users. Our robust, scalable platform helps you build:
2962

30-
We've 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 we keep actively growing.
31-
Our APIs are used by more than a billion end-users, and you'll have a chance to make a huge impact on the product within a team of the strongest engineers all over the world.
63+
- **In-app Messaging** - Group chats, direct messaging, channels
64+
- **Team Collaboration** - Slack-like workspaces and threaded conversations
65+
- **Live Streaming** - Interactive live streams with chat
66+
- **Virtual Events** - Engaging event platforms with rich chat features
67+
- **Gaming Communities** - Community building with real-time chat
68+
- **Support Channels** - Customer support with integrated chat
3269

33-
Check out our current openings and apply via [Stream's website](https://getstream.io/team/#jobs).
70+
### ✨ Try Stream for Free
3471

35-
## Icons - for Stream Developers
72+
Ready to add chat to your application? [Sign up for a free Stream account](https://getstream.io/chat/trial/) and start building today!
3673

37-
- The icons for the UI components can be exported from [Figma](https://www.figma.com/files/project/42134328/SDK-Teams-support-files?fuid=1038443988589634784)
74+
* Free tier for smaller applications and testing
75+
* Comprehensive documentation and tutorials
76+
* Enterprise-grade security and compliance
77+
* Dedicated support for paid plans
78+
79+
**[🔗 Check out our interactive demos →](https://getstream.io/chat/demos/)**
80+
81+
## 👩‍💻 We're Hiring!
82+
83+
We've [raised $38 million in Series B funding](https://techcrunch.com/2021/03/04/stream-raises-38m-as-its-chat-and-activity-feed-apis-power-communications-for-1b-users/) and are actively expanding our team of talented engineers.
84+
85+
Join us in building communication APIs used by over a billion end-users. You'll have the opportunity to make a significant impact on our products alongside some of the best engineers from around the world.
86+
87+
[**View Open Positions →**](https://getstream.io/team/#jobs)
88+
89+
## 🔣 Icons - for Stream Developers
90+
91+
- The icons for UI components can be exported from [Figma](https://www.figma.com/files/project/42134328/SDK-Teams-support-files?fuid=1038443988589634784)
3892
- Icons are used as fonts, the font files are located in `src/assets/icons`
3993
- If you need to change icons you have to regenerate the icon fonts:
4094

@@ -43,3 +97,7 @@ Check out our current openings and apply via [Stream's website](https://getstrea
4397
3. Edit the font
4498
4. Set the font name to `stream-chat-icons` and the CSS prefix to `str-chat__icon--`
4599
5. Download the font, and copy the content of the `font` folder to `src/assets/icons`, and copy the mapping from `css/stream-chat-icons.css` to `src/v2/Icon/Icon-layout.scss`
100+
101+
## 📄 License
102+
103+
MIT © [Stream.io Inc.](https://getstream.io)

0 commit comments

Comments
 (0)