-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: implements socket client readme
- Loading branch information
1 parent
7c0d049
commit 58c5c8b
Showing
2 changed files
with
22 additions
and
37 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,39 +1,17 @@ | ||
<!-- | ||
This README describes the package. If you publish this package to pub.dev, | ||
this README's contents appear on the landing page for your package. | ||
<p align="center"> | ||
<a href="https://superviz.com/" target="blank"><img src="https://avatars.githubusercontent.com/u/56120553?s=200&v=4" width="120" alt="Nest Logo" /></a> | ||
</p> | ||
|
||
For information about how to write a good package README, see the guide for | ||
[writing package pages](https://dart.dev/tools/pub/writing-package-pages). | ||
<p align="center"> | ||
<img alt="Package versions", src="https://img.shields.io/pub/v/superviz_socket_client.svg"> | ||
<img alt="Discord" src="https://img.shields.io/discord/1171797567223378002"> | ||
<img alt="GitHub issues" src="https://img.shields.io/github/issues-raw/superviz/sdk"> | ||
<img alt="GitHub pull requests" src="https://img.shields.io/github/issues-pr/superviz/sdk"> | ||
<img alt="License" src="https://img.shields.io/github/license/superviz/sdk"> | ||
</p> | ||
|
||
For general information about developing packages, see the Dart guide for | ||
[creating packages](https://dart.dev/guides/libraries/create-packages) | ||
and the Flutter guide for | ||
[developing packages and plugins](https://flutter.dev/to/develop-packages). | ||
--> | ||
SuperViz provides powerful SDKs and APIs that enable developers to easily integrate real-time features into mobile applications. Our platform accelerates development across various industries with robust, scalable infrastructure and a low-code approach. | ||
|
||
TODO: Put a short description of the package here that helps potential users | ||
know whether this package might be useful for them. | ||
You can also combine components to create a custom solution for your application. | ||
|
||
## Features | ||
|
||
TODO: List what your package can do. Maybe include images, gifs, or videos. | ||
|
||
## Getting started | ||
|
||
TODO: List prerequisites and provide or point to information on how to | ||
start using the package. | ||
|
||
## Usage | ||
|
||
TODO: Include short and useful examples for package users. Add longer examples | ||
to `/example` folder. | ||
|
||
```dart | ||
const like = 'sample'; | ||
``` | ||
|
||
## Additional information | ||
|
||
TODO: Tell users more about the package: where to find more information, how to | ||
contribute to the package, how to file issues, what response they can expect | ||
from the package authors, and more. | ||
How to start coding with SuperViz? After installing this package, you’ll need to [create an account](https://dashboard.superviz.com/) to retrieve a SuperViz Token and start coding. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters