hausgold / conversejs Goto Github PK

This gem provides the converse.js JavaScript library for your Rails 4+ application.

• Installation
• Usage
• Development
• Code of Conduct
• Contributing
• Releasing

Add this line to your application's Gemfile:

gem 'conversejs'

And then execute:

$ bundle

Or install it yourself as:

$ gem install conversejs

The converse.js files will be added to the asset pipeline and available for you to use. If they're not already in app/assets/javascripts/application.js by default, add this line:

//= require converse

The converse.js library comes also with a stylesheet which must be included to your app/assets/stylesheets/application.scss. Just add this line:

@import "converse";

After checking out the repo, run make install to install dependencies. Then, run make test to run the tests. You can also run make shell-irb for an interactive prompt that will allow you to experiment.

Everyone interacting in the project codebase, issue tracker, chat rooms and mailing lists is expected to follow the code of conduct.

Bug reports and pull requests are welcome on GitHub at https://github.com/hausgold/conversejs. Make sure that every pull request adds a bullet point to the changelog file with a reference to the actual pull request.

The release process of this Gem is fully automated. You just need to open the Github Actions Release Workflow and trigger a new run via the Run workflow button. Insert the new version number (check the changelog first for the latest release) and you're done.