Skip to content

Update Readme to refer to appropriate resources #46

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Rychard wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update Readme to refer to appropriate resources #46

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 27 additions & 25 deletions Readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,41 +25,43 @@ optional procotol extensions. More specifically, the following features are supp
+ Free to use in commercial and personal projects (MIT License)


### Where to get it

You can always get the latest binary package on [Nuget](http://www.nuget.org/packages/S22.Xmpp) or
download the binaries as a .zip archive from [GitHub](http://smiley22.github.com/Downloads/S22.Xmpp.zip).
The [documentation](http://smiley22.github.com/S22.Xmpp/Documentation/) is also available for offline viewing
as HTML or CHM and can be downloaded from
[here](http://smiley22.github.com/Downloads/S22.Xmpp.Html.Documentation.zip) and
[here](http://smiley22.github.com/Downloads/S22.Xmpp.Chm.Documentaton.zip), respectively.
### How to get it

``` Powershell
Install-Package Sharp.Xmpp
```

### Usage & Examples

To use the library add the S22.Xmpp.dll assembly to your project references in Visual Studio. Here's
a simple example that initializes a new instance of the XmppClient class and connects to an XMPP
To use the library add the `Sharp.Xmpp.dll` assembly to your project references in Visual Studio. Here's
a simple example that initializes a new instance of the `XmppClient` class and connects to an XMPP
server:

using System;
using S22.Xmpp;
using S22.Xmpp.Client;

namespace Test {
class Program {
static void Main(string[] args) {
/* connect on port 5222 using TLS/SSL if available */
using (var client = new XmppClient("jabber.se", "username", "password"))
{
Console.WriteLine("Connected as " + client.Jid);
}
}
}
}
``` csharp
using System;
using Sharp.Xmpp;
using Sharp.Xmpp.Client;

namespace Test {
class Program {
static void Main(string[] args) {
/* connect on port 5222 using TLS/SSL if available */
using (var client = new XmppClient("jabber.se", "username", "password"))
{
Console.WriteLine("Connected as " + client.Jid);
}
}
}
}
```

Please see the [documentation](http://smiley22.github.com/S22.Xmpp/Documentation/) for a getting started
guide, examples and details on using the classes and methods exposed by the S22.Xmpp assembly.

The documentation is also available for offline viewing in
[`HTML`](http://smiley22.github.com/Downloads/S22.Xmpp.Html.Documentation.zip) and
[`CHM`](http://smiley22.github.com/Downloads/S22.Xmpp.Chm.Documentaton.zip) formats.


### Credits

Expand Down