Skip to content

Commit fd6e23f

Browse files
committed
doc: 📝 Updated readme
1 parent 3241f15 commit fd6e23f

File tree

2 files changed

+6
-19
lines changed

2 files changed

+6
-19
lines changed

README.md

Lines changed: 4 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,7 @@
55
[![chatview](https://img.shields.io/pub/v/chatview?label=chatview)](https://pub.dev/packages/chatview)
66
[![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/SimformSolutionsPvtLtd/flutter_chatview/blob/main/LICENSE)
77

8-
ChatView is a Flutter package that allows you to integrate a highly customizable chat UI in your
9-
Flutter applications
10-
with [Flexible Backend Integration](https://pub.dev/packages/flutter_chatview_db_connection).
8+
A Flutter package that allows you to integrate highly customizable chat UI in your Flutter applications.
119

1210
![Preview](https://raw.githubusercontent.com/SimformSolutionsPvtLtd/flutter_chatview/main/preview/chatview.gif)
1311

@@ -24,33 +22,22 @@ with [Flexible Backend Integration](https://pub.dev/packages/flutter_chatview_db
2422
- Reply suggestions
2523
- Message status indicators (sent, delivered, read)
2624
- Highly customizable UI components
27-
- Plug-and-play backend support
28-
using [flutter_chatview_db_connection](https://pub.dev/packages/flutter_chatview_db_connection)
2925

3026
## Documentation
3127

32-
Visit our [documentation](https://simform-flutter-packages.web.app/chatView) site for detailed guides, API references, and examples.for detailed guides, API references, code examples, and more. All implementation details, usage instructions, and advanced features can be found in the documentation.
28+
Visit our [documentation](https://simform-flutter-packages.web.app/chatView) site for all implementation details, usage instructions, code examples, and advanced features.
3329

34-
We welcome improvements to our documentation! If you find any issues or have suggestions, please [create an issue](https://github.com/SimformSolutionsPvtLtd/flutter_chatview/issues). To contribute fixes, please create a pull request with your changes to the `doc/documentation.md` file. We appreciate your help in making our documentation better!
3530
## Installation
3631

3732
```yaml
3833
dependencies:
3934
chatview: <latest-version>
4035
```
4136
42-
## ChatView with Backend Support
43-
44-
Make `ChatView` backend-ready
45-
with [flutter_chatview_db_connection](https://pub.dev/packages/flutter_chatview_db_connection)
46-
47-
- 🔌 Easy backend integration without boilerplate (🔥 Firebase)
48-
- ⚙️ Setup in 3 steps: set **Service Type** -> **User ID** and get **`ChatManager`**
49-
- 💬 Supports **1-on-1** and **group chats** with **media uploads** *(audio not supported).*
50-
5137
## Support
5238
53-
For issues or feature requests, please [create an issue](https://github.com/SimformSolutionsPvtLtd/flutter_chatview/issues) on GitHub.
39+
For questions, issues, or feature requests, [create an issue](https://github.com/SimformSolutionsPvtLtd/flutter_chatview/issues) on GitHub or reach out via the GitHub Discussions tab. We're happy to help and encourage community contributions.
40+
To contribute documentation updates specifically, please make changes to the doc/documentation.md file and submit a pull request.
5441
5542
## License
5643
This project is licensed under the MIT License - see the [LICENSE](https://simform-flutter-packages.web.app/chatView/license).

doc/documentation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ Add the following keys to your _Info.plist_ file, located in `<project root>/ios
8181
```
8282

8383
* This plugin requires iOS 10.0 or higher. Add this line in `Podfile`:
84-
```
84+
```text
8585
platform :ios, '10.0'
8686
```
8787

@@ -838,7 +838,7 @@ If you find any bugs or have feature requests, please create an issue in the [is
838838

839839
# License
840840

841-
```text
841+
```
842842
MIT License
843843
Copyright (c) 2022 Simform Solutions
844844
Permission is hereby granted, free of charge, to any person obtaining a copy

0 commit comments

Comments
 (0)