Merge pull request #31 from RobotlegsJS/update-readme

Add instructions about how to install and use the SignalsJS

Author: tiagoschenkel

.npmignore

@@ -10,7 +10,6 @@
 /test
 /transpiled-code
 /typings
-CHANGELOG.md
 CODE_OF_CONDUCT.md
 CONTRIBUTING.md
 ISSUE_TEMPLATE.md

CHANGELOG.md

@@ -18,7 +18,7 @@
 
 ## Signals 0.0.1
 
-### v0.0.12
+### [v0.0.12](https://github.com/RobotlegsJS/SignalsJS/releases/tag/0.0.12) - 2017-11-14
 
 - Add Changelog (see #25).
 
@@ -28,6 +28,8 @@
 
 - Add Pull Request Template (see #28).
 
+- Update README (see #31).
+
 - Solve compilers deprecation warning messages from mocha.
 
 - Update dev dependencies to latest version.

README.md

@@ -9,18 +9,61 @@ SignalsJS
 [![Greenkeeper badge](https://badges.greenkeeper.io/RobotlegsJS/SignalsJS.svg)](https://greenkeeper.io/)
 [![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
 
-TypeScript port of [AS3 Signals](https://github.com/robertpenner/as3-signals).
-[13kb compressed](dist/signals.min.js).
+**SignalsJS** is a [TypeScript](https://www.typescriptlang.org/) port of [AS3 Signals](https://github.com/robertpenner/as3-signals).
+[15KB compressed](dist/signals.min.js).
+
+About
+---
+
+**Signals** are light-weight, strongly-typed messaging tools.
+Wire your application with better APIs and less boilerplate than normal event systems.
+
+Concept
+---
+
+* A **Signal** is essentially a mini-dispatcher specific to one event, with its own array of listeners.
+* A **Signal** gives an event a concrete membership in a class.
+* Listeners subscribe to real objects, not to string-based channels.
+* Event string constants are no longer needed.
+* **Signals** was originally implemented by [Robert Penner](https://github.com/robertpenner) in [AS3](https://github.com/robertpenner/as3-signals).
+* **Signals** are inspired by [C# events](http://en.wikipedia.org/wiki/C_Sharp_syntax#Events) and [signals/slots](http://en.wikipedia.org/wiki/Signals_and_slots) in Qt.
+
+Syntax
+---
+
+```typescript
+// with DOM EventListener
+button.addEventListener("click", onClick);
+
+// Signal equivalent; past tense is recommended
+button.clicked.add(onClicked);
+```
+
+Installation
+---
+
+You can get the latest release and the type definitions using [NPM](https://www.npmjs.com/):
+
+```bash
+npm install @robotlegsjs/signals
+```
+
+Or using [Yarn](https://yarnpkg.com/en/):
+
+```bash
+yarn add @robotlegsjs/signals
+````
 
 Usage
 ---
 
-```ts
+```typescript
 import { Signal } from "@robotlegsjs/signals";
-var signal = new Signal();
+
+let signal = new Signal();
 
 signal.add(data => {
-  console.log(data.message);
+    console.log(data.message);
 });
 
 signal.dispatch({ message: "hello signal!" });