Lines of Code Maintainability Prettier-Standard StandardRB

CableReady

Out-of-Band Server Triggered DOM Operations

CableReady provides a simple interface for triggering client-side DOM operations from the server via ActionCable.

Please read the official ActionCable docs to learn more about ActionCable before proceeding.

Docs

Contributing

Code of Conduct

Everyone interacting with CableReady is expected to follow the Code of Conduct

Coding Standards

This project uses Standard and prettier-standard to minimize bike shedding related to code formatting.

Please run ./bin/standardize prior submitting pull requests.

Releasing

  1. Bump version number at lib/cable_ready/version.rb
  2. Run rake build
  3. Run rake release
  4. Change directories cd ./javascript
  5. Run yarn publish - NOTE: this will throw a fatal error because the tag already exists but the package will still publish

License

CableReady is released under the MIT License.