Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/xmppo/jabber-net
A modern fork of Jabber-Net
https://github.com/xmppo/jabber-net
dotnet jabber xmpp
Last synced: 5 days ago
JSON representation
A modern fork of Jabber-Net
- Host: GitHub
- URL: https://github.com/xmppo/jabber-net
- Owner: xmppo
- Created: 2016-08-27T10:55:09.000Z (about 8 years ago)
- Default Branch: develop
- Last Pushed: 2020-05-14T14:06:00.000Z (over 4 years ago)
- Last Synced: 2024-10-03T17:48:42.538Z (about 1 month ago)
- Topics: dotnet, jabber, xmpp
- Language: C#
- Homepage: https://github.com/xmppo/Jabber-Net
- Size: 34.3 MB
- Stars: 37
- Watchers: 13
- Forks: 13
- Open Issues: 39
-
Metadata Files:
- Readme: Readme.md
- License: licenses/Jabber-Net_LGPLv3.txt
Awesome Lists containing this project
README
Jabber-Net [![NuGet][nuget-badge]][nuget] [![Appveyor build][appveyor-badge]][appveyor] [![Travis build][travis-badge]][travis]
==========
⚠ This project is **deprecated**, reasons are listed in
[#110](https://github.com/ForNeVeR/Jabber-Net/pull/110). Please use other XMPP
libraries for .NET:
- [Ubiety.Xmpp.Core](https://github.com/ubiety/Ubiety.Xmpp.Core)
- [SharpXMPP](https://github.com/vitalyster/SharpXMPP/) (maintained by a former
maintainer of Jabber-Net)
Jabber-Net is a set of .NET classes for sending and receiving Extensible
Messaging and Presence Protocol (XMPP), also known as the Jabber. Client
connections, server component connections, presence, service discovery, and the
like.
Dependencies
------------
This project uses [Paket][paket] dependency manager. Before opening the solution
or building the project, you should install Paket (or Paket bootstrapper) into
`.paket` directory and download the dependencies using the following commands:
```console
$ ./.paket/paket.bootstrapper.exe
$ ./.paket/paket.exe restore
```
For convenience, there is a script `scripts/Install.ps1` that will download
Paket bootstrapper and call these commands automatically. [PowerShell
6.0+][pwsh] is recommended to execute this script.
Consult the script documentation to discover its parameters.
Build and test
--------------
Either use Visual Studio 2017 on Windows or `paket` + `msbuild` / `xbuild` in
your terminal. On Windows:
```console
> .\.paket\paket.exe restore
> msbuild jabber-net.sln /p:Configuration=Debug
> .\packages\NUnit.ConsoleRunner.3.4.1\tools\nunit3-console.exe .\test\bin5\Debug\test.dll
```
On Linux:
```console
$ mono ./.paket/paket.exe restore
$ xbuild /p:Configuration=Debug jabber-net.sln
$ mono ./packages/NUnit.ConsoleRunner.3.4.1/tools/nunit3-console.exe ./test/bin5/Debug/test.dll
```
Documentation
-------------
The documentation is placed in the `docs` directory. To build HTML
documentation, invoke the following commands (PowerShell syntax):
```powershell
$env:JABBER_NET_ROOT = 'https://fornever.github.io/Jabber-Net'
$fsi = 'C:\Program Files (x86)\Microsoft SDKs\F#\4.1\Framework\v4.0\Fsi.exe'
Remove-Item -Recurse .\docs\output
& $fsi docs\generate.fsx
docs\output\index.html
```
There's a convenience script `scripts/Build-Docs.ps1` for that.
You may then publish the `docs/output` directory through a Web server, or just
read the documentation from your local drive.
Packaging
---------
To build [NuGet][nuget] package for Jabber-Net, use the script
`scripts/Package.ps1`. If you want to push this package to the Nuget feed, use
`scripts/Push-Package.ps1`.
Consult the scripts documentation to get the information about their parameters.
Licensing
---------
The project source code is generally licensed under the terms of LGPLv3. Please
consult [Licensing.md][] for details on licensing of internal components.
[Licensing.md]: ./Licensing.md
[appveyor]: https://ci.appveyor.com/project/ForNeVeR/jabber-net/branch/develop
[nuget]: https://www.nuget.org/packages/jabber-net/
[paket]: https://fsprojects.github.io/Paket/index.html
[pwsh]: https://github.com/powershell/powershell
[travis]: https://travis-ci.org/ForNeVeR/Jabber-Net
[appveyor-badge]: https://ci.appveyor.com/api/projects/status/9q5rgknk80oh5g3a/branch/develop?svg=true
[nuget-badge]: https://img.shields.io/nuget/v/jabber-net.svg?maxAge=2592000
[travis-badge]: https://travis-ci.org/ForNeVeR/Jabber-Net.svg?branch=develop