https://github.com/iamvery/phoenix_jank

https://github.com/iamvery/phoenix_jank

elixir jank phoenix ratchet realtime

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/iamvery/phoenix_jank
• Owner: iamvery
• License: mit
• Created: 2016-09-16T12:40:48.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2016-11-04T12:14:55.000Z (over 8 years ago)
• Last Synced: 2024-12-15T06:18:12.151Z (about 2 months ago)
• Topics: elixir, jank, phoenix, ratchet, realtime
• Language: Elixir
• Size: 13.7 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Phoenix Jank

[![Build Status][travis-img]][travis] [![Hex Version][hex-img]][hex]

[travis-img]: https://travis-ci.org/iamvery/phoenix_jank.svg?branch=master

[travis]: https://travis-ci.org/iamvery/phoenix_jank

[hex-img]: https://img.shields.io/hexpm/v/phoenix_jank.svg

[hex]: https://hex.pm/packages/phoenix_jank

[Phoenix][phoenix] integration with [Jank][jank] client library.

View the [Documentation][docs].

## Usage

1. Install with Hex:

   ```elixir

   def deps do

     [{:phoenix_jank, "~> 0.1.0"}]

   end

   ```

TODO add more usage docs

## Release

1. Bump the version in `mix.exs`.

1. Bump the version in `package.json`.

1. Add version to CHANGELOG.

1. Commit version with Git tag `vX.X.X`.

1. Publish to Hex

   ```

   $ mix do hex.publish, hex.publish docs

   ```

1. Publish to npm

   ```

   $ npm publish

   ```

[phoenix]: http://www.phoenixframework.org/

[jank]: https://github.com/iamvery/jank

[docs]: https://hexdocs.pm/phoenix_ratchet