From 20b07a0dffd4a4bb88deaab07cd98fbfc40eff23 Mon Sep 17 00:00:00 2001
From: Pawel Kadluczka <pawelka@microsoft.com>
Date: Thu, 14 Sep 2017 16:16:46 -0700
Subject: [PATCH] Adding README to npm module

---
 client-ts/.npmignore |  1 +
 client-ts/README.md  | 34 ++++++++++++++++++++++++++++++++++
 2 files changed, 35 insertions(+)
 create mode 100644 client-ts/README.md

diff --git a/client-ts/.npmignore b/client-ts/.npmignore
index 9ff305ca16..0c9c01dd44 100644
--- a/client-ts/.npmignore
+++ b/client-ts/.npmignore
@@ -1,2 +1,3 @@
 *
 !dist/**/*
+!README.md
diff --git a/client-ts/README.md b/client-ts/README.md
new file mode 100644
index 0000000000..084db3f6e0
--- /dev/null
+++ b/client-ts/README.md
@@ -0,0 +1,34 @@
+JavaScript and TypeScript clients for SignalR for ASP.NET Core
+
+## Installation
+
+```bash
+npm install @aspnet/signalr-client
+```
+
+## Usage
+
+### Browser
+
+To use the client in a browser, copy `*.js` files from the `dist/browser` folder to your script folder include on your page using the `<script>` tag.
+
+### Node.js
+
+The following polyfills are required to use the client in Node.js applications:
+- `XmlHttpRequest` - always
+- `WebSockets` - to use the WebSockets transport
+- `EventSource` - to use the ServerSentEvents transport
+- `btoa/atob` - to use binary protocols (e.g. MessagePack) over text transports (ServerSentEvents)
+
+### Example
+
+```JavaScript
+let connection = new signalR.HubConnection('/chat');
+
+connection.on('send', data => {
+    console.log(data);
+});
+
+connection.start()
+    .then(() => connection.invoke('send', 'Hello'));
+```
\ No newline at end of file