update to version 2.1.2

CHANGELOG.md

@@ -1,6 +1,14 @@
-# 2.1.1 - 2024-09-02
+# 2.1.2 - 2024-09-24
+
+- **Documentation**
+  - The documentation [page](https://whixp.dosy.app/) is now live! Explore detailed instructions on how to use the package and its features.
+- **Bug Fixes**
+  - Fixed small bugs related to anonymous server connections.
+
+## 2.1.1 - 2024-09-02
 
 - **Added**
+
   - Message Archive Management (MAM) Support: Implemented support for the MAM extension, allowing users to archive and retrieve chat history more effectively.
   - Displayed Markers Support: Added functionality to handle displayed markers, improving message tracking and read receipt features.
 

README.md

@@ -8,13 +8,13 @@
     <img alt="whixp" src="https://raw.githubusercontent.com/vsevex/whixp/45439a108689b831c39beefa8c98c563f50e3d4f/assets/whixp_dark.svg">
 </div>
 
-Whixp is a lightweight and pure Dart library that allows you to connect to XMPP (Extensible Messaging and Presence Protocol) servers. This package provides a range of fundamental functionalities for XMPP communication.
+## Introduction
 
-## XMPP
+Welcome to Whixp (/wɪksp/)!
 
-XMPP is an open source standart protocol widely used for real-time communication, enabling features such as instant messaging, presence information, and contact list management.
+Whixp is a lightweight and pure Dart library that allows you to connect to XMPP (Extensible Messaging and Presence Protocol) servers.
 
-With this package, you can easily integrate XMPP capabilities into your Dart & Flutter applications, facilitating secure communication between users.
+For learning how to use [Whixp](https://github.com/vsevex/whixp), see its [documentation](https://whixp.dosy.app/).
 
 ## Features
 
@@ -24,34 +24,10 @@ With this package, you can easily integrate XMPP capabilities into your Dart & F
 
 **Extensions Support**: Extensible architecture supports XMPP protocol extensions.
 
-**Authentication Mechanisms**: Provides support for various XMPP authentication mechanisms, including **SASL SCRAM** with encryption options such as SHA-1, SHA-256, SHA-384, SHA-512, PLAIN and ANONYMOUS.
-
-**Pluggable Architecture**: Build on top of a modular and pluggable architecture. You can easily extend and customize Whixp to fit your specific use case.
-
-**Fundamental Functionalities**: Whixp provides a set of fundamental functionalities, including sending and retrieving messages, presence management, roster management, and more.
-
 **Pure Dart implementation**: Written in pure Dart, enabling easy integration with Dart and Flutter projects.
 
 **Lightweight**: Whixp is designed to be lightweight, providing a streamlined solution for XMPP connectivity without unnecessary dependencies or overhead.
 
-## Supported Protocol Extensions
-
-**[Data Forms (XEP-0004)](https://xmpp.org/extensions/xep-0004.html)**: Allows for the exchange of structured data, often used for service configuration and reporting.
-
-**[Publish-Subscribe (PubSub) (XEP-0060)](https://xmpp.org/extensions/xep-0060.html)**: Facilitates a publish-subscribe messaging pattern, distributing information to interested parties efficiently.
-
-**[Stream Management (XEP-0198)](https://xmpp.org/extensions/xep-0198.html)**: Enhances connection reliability with features like message acknowledgment and session resumption, supporting offline storage.
-
-**[vCard4 over PubSub (XEP-0292)](https://xmpp.org/extensions/xep-0292.html)**: Enables sharing and retrieving profile information like name and email in a structured format using PubSub.
-
-**[Message Archive Management (XEP-0313)](https://xmpp.org/extensions/xep-0313.html)**: Allows servers to store and retrieve archived messages for improved user experience and data continuity.
-
-**[Push Notifications (XEP-0357)](https://xmpp.org/extensions/xep-0357.html)**: Integrates push notification support for real-time communication systems.
-
-These extensions provide a robust foundation for advanced XMPP functionalities, ensuring Whixp is suitable for various real-time communication needs.
-
-> Explore the examples provided to understand how to use these extensions, including messaging, PubSub, and stream management.
-
 ## API
 
 This code snippet demonstrates how to establish a connection using the `Whixp` package.

pubspec.yaml

@@ -1,6 +1,6 @@
 name: whixp
 description: Streamline your XMPP messaging with a lightweight Dart-based XMPP client
-version: 2.1.1
+version: 2.1.2
 repository: https://github.com/vsevex/whixp
 issue_tracker: https://github.com/vsevex/whixp/issues
 topics: [xmpp, network, socket]