feat: Add docs for including a tagged version

This commit is contained in:
PapaTutuWawa 2023-01-10 12:25:56 +01:00
parent 7ce6703c5b
commit 9223a7d403
3 changed files with 23 additions and 3 deletions

View File

@ -3,13 +3,13 @@
moxxmpp is a XMPP library written purely in Dart for usage in Moxxy. moxxmpp is a XMPP library written purely in Dart for usage in Moxxy.
## Packages ## Packages
### moxxmpp ### [moxxmpp](./packages/moxxmpp)
This package contains the actual XMPP code that is platform-independent. This package contains the actual XMPP code that is platform-independent.
### moxxmpp_socket ### [moxxmpp_socket_tcp](./packages/moxxmpp_socket_tcp)
`moxxmpp_socket` contains the implementation of the `BaseSocketWrapper` class that `moxxmpp_socket_tcp` contains the implementation of the `BaseSocketWrapper` class that
implements the RFC6120 connection algorithm and XEP-0368 direct TLS connections, implements the RFC6120 connection algorithm and XEP-0368 direct TLS connections,
if a DNS implementation is given, and supports StartTLS. if a DNS implementation is given, and supports StartTLS.

View File

@ -2,6 +2,16 @@
A pure-Dart XMPP library written for Moxxy. A pure-Dart XMPP library written for Moxxy.
## Usage
Include the following as a dependency in your pubspec file:
```
moxxmpp:
hosted: https://git.polynom.me/api/packages/Moxxy/pub
version: 0.1.6+1
```
## License ## License
See `./LICENSE`. See `./LICENSE`.

View File

@ -11,6 +11,16 @@ to return the list of SRV records, encoded by `MoxSrvRecord` objects. To perform
resolution, one can use any DNS library. A Flutter plugin implementing SRV resolution resolution, one can use any DNS library. A Flutter plugin implementing SRV resolution
is, for example, [moxdns](https://codeberg.org/moxxy/moxdns). is, for example, [moxdns](https://codeberg.org/moxxy/moxdns).
## Usage
Include the following as a dependency in your pubspec file:
```
moxxmpp_socket_tcp:
hosted: https://git.polynom.me/api/packages/Moxxy/pub
version: 0.1.2+9
```
## License ## License
See `./LICENSE`. See `./LICENSE`.