Skip to content

Commit

Permalink
docs(readme): add internal links and badges
Browse files Browse the repository at this point in the history
  • Loading branch information
Morgan Touverey-Quilling authored May 18, 2017
1 parent e8209a2 commit 359f2e0
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<img src="https://raw.githubusercontent.com/toverux/expresse/master/expresse.png" alt="AssetBundleCompiler logo" align="right">

# ExpreSSE [![Travis Build](https://img.shields.io/travis/toverux/expresse.svg?style=flat-square)](https://travis-ci.org/toverux/expresse) ![typescript compatible](https://img.shields.io/badge/typescript-compatible-green.svg?style=flat-square)
# ExpreSSE [![npm version](https://img.shields.io/npm/v/@toverux/expresse.svg?style=flat-square)](https://www.npmjs.com/package/@toverux/expresse) ![license](https://img.shields.io/github/license/mitmadness/UnityInvoker.svg?style=flat-square) [![Travis Build](https://img.shields.io/travis/toverux/expresse.svg?style=flat-square)](https://travis-ci.org/toverux/expresse) ![typescript compatible](https://img.shields.io/badge/typescript-compatible-green.svg?style=flat-square)

----------------

Expand All @@ -10,6 +10,11 @@ From the MDN:

> Traditionally, a web page has to send a request to the server to receive new data; that is, the page requests data from the server. With server-sent events, it's possible for a server to send new data to a web page at any time, by pushing messages to the web page.
- [Installation & Usage](#package-installation--usage)
- [`sse()` middleware](#sse-middleware)
- Notes:
[About browser support](#about-browser-support), [Using a serializer for messages's `data` field](#using-a-serializer-for-messages-data-fields)

----------------

## :package: Installation & Usage
Expand Down Expand Up @@ -68,6 +73,8 @@ interface ISSEMiddlewareOptions {
keepAliveInterval?: number;
}
```

:arrow_right: [Read more about `serializer`](#using-a-serializer-for-messages-data-fields)
</details>
<br>

Expand Down Expand Up @@ -103,7 +110,7 @@ router.get('/events', sse(/* options */), (req, res: ISSECapableResponse) => {

### About browser support

The W3C standard client for Server-Sent events is [EventSource](https://developer.mozilla.org/fr/docs/Web/API/EventSource). Unfortunately, it is not yep implemented in Internet Explorer or Microsoft Edge.
The W3C standard client for Server-Sent events is [EventSource](https://developer.mozilla.org/fr/docs/Web/API/EventSource). Unfortunately, it is not yet implemented in Internet Explorer or Microsoft Edge.

You may want to use a polyfill on the client side if your application targets those browsers.

Expand Down

0 comments on commit 359f2e0

Please sign in to comment.