Skip to content

Commit

Permalink
Updated logo and readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jakiestfu committed Aug 2, 2016
1 parent 27c3b41 commit 111bf43
Show file tree
Hide file tree
Showing 3 changed files with 35 additions and 5 deletions.
34 changes: 32 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,35 @@

> A powerful, simple, promise-based `postMessage` library.
[![npm][npm-image]][npm-url]

[npm-image]: https://img.shields.io/npm/v/postmate.svg?style=flat-square
[npm-url]: https://www.npmjs.com/package/postmate

_Postmate_ is a promise-base API built on `postMessage`. It allows a parent page
to speak with a child `iFrame` across origins with minimal effort.

You can download the compiled javascript directly [here](/build/postmate.min.js)

* [Features](#features)
* [Installing](#installing)
* [Glossary](#glossary)
* [Usage](#usage)
* [API](#api)
* [Further Reading](#further-reading)
* [License](#license)

***

## Features
* Promise based API for elegant and simple communication
* Secure. Two way parent <-> child handshake, with origin and message validation.
* Child can expose properties, functions, or promises that the parent can retrieve.
* *Zero* dependencies. Provide your own polyfill or abstraction for the `Promise` API if needed
* Lightweight, weighing in at ~ `3kb`

## Installing
```sh
```bash
$ npm i postmate # Install via NPM
$ bower i postmate # Install via Bower
```
Expand Down Expand Up @@ -55,6 +75,15 @@ new Postmate({

***

## API


***

## Further Reading

### Handshake and Initialization Flow

The Handshake and ready sequence is as follows:
```
Parent: Loading frame
Expand All @@ -70,4 +99,5 @@ Parent awaiting messages...
Parent Page Ready
```

## API
## License
MIT
4 changes: 2 additions & 2 deletions assets/postmate.sketch
Git LFS file not shown
2 changes: 1 addition & 1 deletion assets/postmate.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 111bf43

Please sign in to comment.